Module: Editmode::ActionViewExtensions::EditmodeHelper

Includes:
ActionView::Context, ActionView::Helpers::AssetTagHelper, ActionView::Helpers::TagHelper, ActionView::Helpers::TextHelper, Helper
Included in:
Editmode
Defined in:
lib/editmode/action_view_extensions/editmode_helper.rb

Instance Method Summary collapse

Methods included from Helper

#e, #parse_arguments, #render_custom_field_raw

Instance Method Details

#allowed_tag_attributes ⇒ Object 



19
20
21
 
# File 'lib/editmode/action_view_extensions/editmode_helper.rb', line 19

def allowed_tag_attributes
  [:style, :href, :title, :src, :alt, :width, :height]
end

#api_root_url ⇒ Object 



23
24
25
 
# File 'lib/editmode/action_view_extensions/editmode_helper.rb', line 23

def api_root_url
  ENV["EDITMODE_OVERRIDE_API_URL"] || "https://api.editmode.com"
end

#api_version ⇒ Object 



15
16
17
 
# File 'lib/editmode/action_view_extensions/editmode_helper.rb', line 15

def api_version
  # Todo Add Header Version
end

#chunk_collection(collection_identifier, **options, &block) ⇒ Object Also known as: c 



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/editmode/action_view_extensions/editmode_helper.rb', line 27

def chunk_collection(collection_identifier, **options, &block)
  branch_params = params[:em_branch_id].present? ? "branch_id=#{params[:em_branch_id]}" : ""
  branch_id = params[:em_branch_id].presence
  tags = options[:tags].presence || []
  limit = options[:limit].presence

  parent_class = options[:class] || ""
  item_class = options[:item_class] || ""
  
  begin 
    url_params = { 
      :collection_identifier => collection_identifier,
      :branch_id => branch_id,
      :limit => limit,
      :tags => tags,
      :project_id => Editmode.project_id
    }.to_query

    url = URI(api_root_url)
    url.path = '/chunks'
    url.query = url_params

    cache_identifier = "collection_#{collection_identifier}#{branch_id}#{limit}#{tags.join}"
    cached_content_present = Rails.cache.exist?(cache_identifier)
    
    if !cached_content_present
      response = HTTParty.get(url)
      response_received = true if response.code == 200
    end
    
    if !cached_content_present && !response_received
      raise "No response received"
    else

      chunks = Rails.cache.fetch(cache_identifier) do  
        response['chunks']
      end

      if chunks.any?
        return content_tag :div, class: "chunks-collection-wrapper #{parent_class}", data: {chunk_collection_identifier: collection_identifier, chunk_tags: tags.join("|")} do
          chunks.each_with_index do |chunk, index|
            @custom_field_chunk = chunk
            concat(
              content_tag(:div, class: "chunks-collection-item--wrapper #{item_class}") do
                yield(@custom_field_chunk, index)
              end
            )
          end
          
          # Placeholder element for new collection item
          @custom_field_chunk = chunks.first.merge!({placeholder: true})
          concat(content_tag("em-template", class: "chunks-col-placeholder-wrapper", style: "display: none") do
            yield(@custom_field_chunk, 0)
          end)
        end 
      else
        return content_tag(:span, "&nbsp".html_safe)
      end
    end
  rescue => error
    puts error 
    return ""
  end
end

#chunk_display(label, identifier, options = {}, &block) ⇒ Object Also known as: chunk 



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/editmode/action_view_extensions/editmode_helper.rb', line 161

def chunk_display(label, identifier, options = {}, &block)
  options[:branch_id] = params[:em_branch_id] if params[:em_branch_id].present?
  # This method should never show an error. 
  # If anything goes wrong fetching content
  # We should just show blank content, not
  # prevent the page from loading.
  begin
    field = options[:field].presence || ""          
    options[:referrer] = request.present? && request.url || ""
    chunk_value = Editmode::ChunkValue.new(identifier, **options)
    
    if field.present? && chunk_value.chunk_type == 'collection_item'
      chunk_content = chunk_value.field(field)
      identifier = chunk_value.field_chunk(field)["identifier"]
      chunk_type = chunk_value.field_chunk(field)["chunk_type"]
      options[:collection_id] = chunk_value.collection_id
    else
      chunk_content = chunk_value.content
      chunk_type = chunk_value.chunk_type
      identifier = chunk_value.response["identifier"] unless identifier.include? "cnk_"
    end

    options[:cache_identifier] = chunk_value.identifier
    options[:content_key] = chunk_value.response.try(:[], "content_key")
    render_chunk_content(identifier, chunk_content, chunk_type, options)

  rescue => error
    puts error
    # Show fallback content by default
    return content_tag("em-span", &block) if block_given?
    # Otherwise show a span with no content to 
    # maintain layout
    content_tag("em-span", "&nbsp".html_safe)
  end
end

#chunk_field_value(parent_chunk_object, custom_field_identifier, options = {}) ⇒ Object 



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/editmode/action_view_extensions/editmode_helper.rb', line 93

def chunk_field_value(parent_chunk_object, custom_field_identifier, options = {})
  begin 
    chunk_identifier = parent_chunk_object["identifier"]
    chunk_value = Editmode::ChunkValue.new(parent_chunk_object["identifier"], **options.merge({response: parent_chunk_object}))
    custom_field_item = chunk_value.field_chunk(custom_field_identifier)

    options[:field] = custom_field_identifier
    
    if parent_chunk_object[:placeholder]
      custom_field_item["identifier"] = ""
      custom_field_item["content"] = ""
    end

    if custom_field_item.present?
      render_chunk_content(
        custom_field_item["identifier"],
        chunk_value.field(custom_field_identifier),
        custom_field_item["chunk_type"],
        { parent_identifier: chunk_identifier, custom_field_identifier:  custom_field_identifier}.merge(options)
      )
    end
  rescue => errors
    puts errors
    content_tag(:span, "&nbsp".html_safe) 
  end
end

#no_response_received(id = "") ⇒ Object 



214
215
216
 
# File 'lib/editmode/action_view_extensions/editmode_helper.rb', line 214

def no_response_received(id = "")
  "Sorry, we can't find a chunk using this identifier: \"#{id}\". This can happen if you've deleted a chunk on editmode.com or if your local cache is out of date. If it persists, try running Rails.cache clear."
end

#render_chunk(identifier, *args, &block) ⇒ Object Also known as: E 



207
208
209
210
211
 
# File 'lib/editmode/action_view_extensions/editmode_helper.rb', line 207

def render_chunk(identifier, *args, &block)
  field, options = parse_arguments(args)
  options[:field] = field
  chunk_display('label', identifier, options, &block)
end

#render_chunk_content(chunk_identifier, chunk_content, chunk_type, options = {}) ⇒ Object 



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/editmode/action_view_extensions/editmode_helper.rb', line 120

def render_chunk_content(chunk_identifier, chunk_content, chunk_type, options = {})
  begin 
    css_class = options[:class]
    cache_id = options[:cache_identifier]

    if chunk_type == "image"
      display_type = "image"
    else 
      display_type = options[:display_type] || "span"
    end

    chunk_data = { :chunk => chunk_identifier, :chunk_editable => false, :chunk_type => chunk_type }

    chunk_data.merge!({parent_identifier: options[:parent_identifier]}) if options[:parent_identifier].present?
    chunk_data.merge!({custom_field_identifier: options[:custom_field_identifier]}) if options[:custom_field_identifier].present?
    chunk_data.merge!({chunk_cache_id: cache_id}) if cache_id.present?
    chunk_data.merge!({chunk_collection_identifier: options[:collection_id]}) if options[:collection_id].present?
    chunk_data.merge!({chunk_content_key: options[:content_key]}) if options[:content_key].present?

    case display_type
    when "span"
      if chunk_type == "rich_text"
        content = content_tag("em-span", :class => "editmode-richtext-editor #{css_class}", :data => chunk_data.merge!({:chunk_editable => true}), **options.slice(*allowed_tag_attributes) ) do
          chunk_content.html_safe
        end
      else
        content_tag("em-span", :class => css_class, :data => chunk_data.merge!({:chunk_editable => true}), **options.slice(*allowed_tag_attributes) ) do
          chunk_content.html_safe
        end
      end
    when "image"
      chunk_content = chunk_content.blank? || chunk_content == "/images/original/missing.png" ? 'https://www.editmode.com/upload.png' : chunk_content
      image_tag(chunk_content, :data => chunk_data, :class => css_class, **options.slice(*allowed_tag_attributes)) 
    end
  rescue => errors
    puts errors
    content_tag("em-span", "&nbsp".html_safe) 
  end

end

#render_custom_field(field_name, options = {}) ⇒ Object Also known as: F 



199
200
201
202
203
204
 
# File 'lib/editmode/action_view_extensions/editmode_helper.rb', line 199

def render_custom_field(field_name, options={})
  options[:variable_fallbacks] = @custom_field_chunk["variable_fallbacks"] || {}
  options[:variable_values] = options[:variables] || {}
  
  chunk_field_value(@custom_field_chunk, field_name, **options)
end

#require_field_id ⇒ Object 



218
219
220
 
# File 'lib/editmode/action_view_extensions/editmode_helper.rb', line 218

def require_field_id
  "Field ID or Field Name is required to retrieve a collection item"
end