locomotive_cms 2.0.0.rc12 → 2.0.0

data/lib/locomotive/liquid/tags/consume.rb

@@ -13,12 +13,20 @@ module Locomotive
       #
       class Consume < ::Liquid::Block
 
-        Syntax = /(#{::Liquid::VariableSignature}+)\s*from\s*(#{::Liquid::QuotedString}+)/
+        Syntax = /(#{::Liquid::VariableSignature}+)\s*from\s*(#{::Liquid::QuotedString}|#{::Liquid::VariableSignature}+)/
 
         def initialize(tag_name, markup, tokens, context)
           if markup =~ Syntax
             @target = $1
-            @url = $2.gsub(/['"]/, '')
+            @url = $2
+            @is_var = false
+            if @url.match(::Liquid::QuotedString)
+              @url.gsub!(/['"]/, '')
+            elsif @url.match(::Liquid::VariableSignature)
+              @is_var = true
+            else
+              raise ::Liquid::SyntaxError.new("Syntax Error in 'consume' - Valid syntax: consume <var> from \"<url>\" [username: value, password: value]")
+            end
             @options = {}
             markup.scan(::Liquid::TagAttributes) do |key, value|
               @options[key] = value if key != 'http'
@@ -33,6 +41,9 @@ module Locomotive
         end
 
         def render(context)
+          if @is_var
+            @url = context[@url]
+          end
           render_all_and_cache_it(context)
         end
 

data/lib/locomotive/liquid/tags/csrf.rb

@@ -10,7 +10,7 @@ module Locomotive
             name        = controller.send(:request_forgery_protection_token).to_s
             value       = controller.send(:form_authenticity_token)
 
-            %(<input type="hidden" name="#{name}" value="#{value}" />)
+            %(<input type="hidden" name="#{name}" value="#{value}">)
           end
 
         end
@@ -23,8 +23,8 @@ module Locomotive
             value       = controller.send(:form_authenticity_token)
 
             %{
-              <meta name="csrf-param" content="#{name}" />
-              <meta name="csrf-token" content="#{value}" />
+              <meta name="csrf-param" content="#{name}">
+              <meta name="csrf-token" content="#{value}">
             }
           end
 

data/lib/locomotive/liquid/tags/editable/base.rb

@@ -6,9 +6,11 @@ module Locomotive
 
           Syntax = /(#{::Liquid::QuotedFragment})(\s*,\s*#{::Liquid::Expression}+)?/
 
+          attr_accessor :slug
+
           def initialize(tag_name, markup, tokens, context)
             if markup =~ Syntax
-              @slug = $1.gsub('\'', '')
+              @slug = $1.gsub(/[\"\']/, '')
               @options = { :fixed => false }
               markup.scan(::Liquid::TagAttributes) { |key, value| @options[key.to_sym] = value.gsub(/^'/, '').gsub(/'$/, '') }
             else
@@ -68,11 +70,16 @@ module Locomotive
 
           def render_default_content(context)
             begin
-              render_all(@nodelist, context).join(' ')
-            rescue
-              raise ::Liquid::SyntaxError.new("Error in the #{self.current_block_name || 'default'} block for the #{@slug} editable_element - No liquid tags are allowed inside.")
+              if @nodelist.all? { |n| n.is_a? String }
+                context ||= ::Liquid::Context.new
+
+                render_all(@nodelist, context)
+              else
+                raise ::Liquid::SyntaxError.new("Error in the #{self.current_block_name || 'default'} block for the #{@slug} editable_element - No liquid tags are allowed inside.")
+              end
             end
           end
+
         end
 
       end

data/lib/locomotive/liquid/tags/inline_editor.rb

@@ -6,11 +6,14 @@ module Liquid
         def render(context)
           if context.registers[:current_locomotive_account] && context.registers[:inline_editor]
 
-            plugins = 'common/format,common/table,common/list,common/link,common/highlighteditables,common/block,common/undo,common/contenthandler,common/paste,common/commands,common/abbr,common/align,common/horizontalruler,custom/locomotive_media'
+            plugins = 'common/ui,common/format,common/table,common/list,common/link,common/highlighteditables,common/block,common/undo,common/contenthandler,common/paste,common/commands,common/abbr,common/align,common/horizontalruler,common/image,custom/locomotive_media'
 
             controller = context.registers[:controller]
             controller.instance_variable_set(:@plugins, plugins)
 
+            page = context.registers[:page].to_presenter.as_json_for_html_view
+            page['lang'] = context['locale']
+
             html = <<-HTML
               %meta{ :content => true, :name => 'inline-editor' }
 
@@ -20,7 +23,7 @@ module Liquid
               %script{ :type => 'text/javascript' }
                 :plain
                   Aloha.ready(function() \{
-                    window.parent.application_view.set_page(#{controller.view_context.j context.registers[:page].to_presenter.as_json_for_html_view.to_json.html_safe});
+                    window.parent.application_view.set_page(#{controller.view_context.j page.to_json.html_safe});
                   \});
             HTML
 

data/lib/locomotive/liquid/tags/locale_switcher.rb

@@ -48,7 +48,9 @@ module Locomotive
                 fullpath.gsub!('content_type_template', context['entry']._permalink)
               end
 
-              %(<a href="/#{fullpath}" class="#{locale} #{'current' if locale == context['current_locale']}">#{link_label(locale)}</a>)
+              css = link_class(locale, context['locale'])
+
+              %(<a href="/#{fullpath}" class="#{css}">#{link_label(locale)}</a>)
             end
           end.join(@options[:sep])
 
@@ -57,11 +59,17 @@ module Locomotive
 
         private
 
+        def link_class(locale, current_locale)
+          css = [locale]
+          css << 'current' if locale == current_locale
+          css.join(' ')
+        end
+
         def link_label(locale)
           case @options[:label]
-          when :iso     then locale
-          when :locale  then I18n.t("locomotive.locales.#{locale}", :locale => locale)
-          when :title   then @page.title # FIXME: this returns nil if the page has not been translated in the locale
+          when 'iso'     then locale
+          when 'locale'  then I18n.t("locomotive.locales.#{locale}")
+          when 'title'   then @page.title # FIXME: this returns nil if the page has not been translated in the locale
           else
             locale
           end

data/lib/locomotive/liquid/tags/nav.rb

@@ -57,7 +57,7 @@ module Locomotive
 
           if @options[:no_wrapper] != 'true'
             list_class  = !@options[:class].blank? ? %( class="#{@options[:class]}") : ''
-            output      = %{<ul id="#{@options[:id]}"#{list_class}>\n#{output}</ul>}
+            output      = %{<nav id="#{@options[:id]}"#{list_class}><ul>\n#{output}</ul></nav>}
           end
 
           output

data/lib/locomotive/liquid/tags/paginate.rb

@@ -23,6 +23,9 @@ module Locomotive
           if markup =~ Syntax
             @collection_name = $1
             @per_page = $2.to_i
+            @options = { }
+            markup.scan(::Liquid::TagAttributes) { |key, value| @options[key.to_sym] = value.gsub(/^'/, '').gsub(/'$/, '') }
+            @window_size = @options[:window_size] ? @options[:window_size].to_i : 3
           else
             raise ::Liquid::SyntaxError.new("Syntax Error in 'paginate' - Valid syntax: paginate <collection> by <number>")
           end
@@ -90,7 +93,7 @@ module Locomotive
         end
 
         def window_size
-          3
+          @window_size
         end
 
         def no_link(title)

data/lib/locomotive/liquid/tags/seo.rb

@@ -25,8 +25,8 @@ module Locomotive
 
           def render_metadata(context)
             %{
-              <meta name="description" content="#{self.value_for(:meta_description, context)}" />
-              <meta name="keywords" content="#{self.value_for(:meta_keywords, context)}" />
+              <meta name="description" content="#{self.value_for(:meta_description, context)}">
+              <meta name="keywords" content="#{self.value_for(:meta_keywords, context)}">
             }
           end
 

data/lib/locomotive/liquid/tags/snippet.rb

@@ -10,10 +10,10 @@ module Locomotive
         def initialize(tag_name, markup, tokens, context)
           super
 
-          @slug = @template_name.gsub('\'', '')
+          @slug = @template_name.gsub(/['"]/o, '')
 
           if @context[:snippets].present?
-            (@context[:snippets] << @slug).uniq! 
+            (@context[:snippets] << @slug).uniq!
           else
             @context[:snippets] = [@slug]
           end
@@ -59,6 +59,14 @@ module Locomotive
           end
         end
 
+        def nodelist
+          if @partial
+            @partial.root.nodelist
+          else
+            []
+          end
+        end
+
       end
 
       ::Liquid::Template.register_tag('include', Snippet)

data/lib/locomotive/liquid/tags/with_scope.rb

@@ -20,6 +20,7 @@ module Locomotive
         def initialize(tag_name, markup, tokens, context)
           @attributes = HashWithIndifferentAccess.new
           markup.scan(TagAttributes) do |key, value|
+            key = key_to_h4s_symbol(key)
             @attributes[key] = value
           end
           super
@@ -39,6 +40,16 @@ module Locomotive
             attributes[key] = context[value]
           end
         end
+
+        def key_to_h4s_symbol(key)
+          _key, _operator = key.split('.')
+
+          if %w(all exists gt gte in lt lte ne nin size near within).include?(_operator)
+            _key.to_s.to_sym.send(_operator.to_sym)
+          else
+            _key
+          end
+        end
       end
 
       ::Liquid::Template.register_tag('with_scope', WithScope)

data/lib/locomotive/middlewares.rb

@@ -1,4 +1,5 @@
 require 'locomotive/middlewares/fonts'
 require 'locomotive/middlewares/seo_trailing_slash'
 require 'locomotive/middlewares/cache'
-require 'locomotive/middlewares/inline_editor'
+require 'locomotive/middlewares/inline_editor'
+require 'locomotive/middlewares/permalink'

data/lib/locomotive/middlewares/fonts.rb

@@ -31,11 +31,11 @@ module Locomotive
       protected
 
       def fetch_site(domain_name)
-        site_id = Rails.cache.fetch(domain_name, :expires_in => @expires_in) do
+        site_id = Rails.cache.fetch(domain_name, expires_in: @expires_in) do
           Site.match_domain(domain_name).only(:id).first._id.to_s rescue ''
         end
 
-        site_id.blank? ? nil : Site.new(:id => site_id)
+        site_id.blank? ? nil : Site.new(id: site_id)
       end
     end
   end

data/lib/locomotive/middlewares/permalink.rb

@@ -0,0 +1,22 @@
+module Locomotive
+  module Middlewares
+    class Permalink
+
+      def initialize(app, opts = {})
+        @app = app
+      end
+
+      def call(env)
+        if env['PATH_INFO'] =~ /^#{Locomotive.mounted_on}\/_permalink.json/
+          request     = Rack::Request.new(env)
+          underscore  = request.params['underscore'] == '1'
+          value       = request.params['string'].try(:permalink, underscore)
+
+          [200, {}, [{ value: value }.to_json]]
+        else
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/locomotive/misc/api_documentation.rb

@@ -0,0 +1,114 @@
+require 'haml'
+
+module Locomotive
+  module Misc
+
+    # Class to generate the documentation about the LocomotiveCMS Rest API
+    #
+    module ApiDocumentation
+
+      # Generate the documentation depending on the renderer
+      # which is by default the BoostrapRenderer.
+      #
+      # @param [ Object ] renderer The instance of the renderer.
+      #
+      #
+      def self.generate(renderer = nil)
+        renderer ||= BootstrapRenderer.new
+
+        raise 'You must provide a renderer' if renderer.nil?
+
+        parser = Parser.new
+        parser.parse
+
+        renderer.render(parser.resources, self.embedded_resources)
+      end
+
+      # Return the list of embedded resources
+      #
+      # @return [ Array ] The list of hashes (keys: name, getters, setters)
+      #
+      def self.embedded_resources
+        %w(editable_element editable_short_text editable_long_text editable_file editable_control content_field).map do |name|
+          klass = "Locomotive::#{name.camelize}Presenter".constantize
+          {
+            name:     name,
+            getters:  klass.getters_to_hash,
+            setters:  klass.setters_to_hash,
+          }
+        end
+      end
+
+      class Parser
+
+        attr_reader :resources
+
+        def initialize
+          @resources = []
+        end
+
+        # Take all the routes and build the set of RESTFUL resources
+        #
+        def parse
+          routes = Rails.application.routes.routes.each do |route|
+            next unless route.path.spec.to_s =~ %r{^/locomotive/api/}
+
+            name        = route.defaults[:controller].split('/').last
+            resource    = resources.find { |r| r[:name] == name }
+            controller  = "#{route.defaults[:controller]}_controller".camelize.constantize
+            action      = route.defaults[:action].to_sym
+            verb        = route.verb.inspect.gsub("\/^", '').gsub("$\/", '')
+
+            if resource.nil?
+              resource = controller.description
+              resource[:name] = name
+              self.resources << resource
+            end
+
+            resource[:actions][action] ||= {}
+            resource[:actions][action].merge!(path: route.path.spec.to_s, verb: verb)
+
+            self.sanitize_attributes(resource[:actions][action])
+          end
+
+          self.resources
+        end
+
+        protected
+
+        def sanitize_attributes(action)
+          action[:params].each do |name, type_or_all|
+            next unless type_or_all.is_a?(String)
+            action[:params][name] = { type: type_or_all, required: true }
+          end unless action[:params].blank?
+
+          action[:response].each do |name, type_or_all|
+            next unless type_or_all.is_a?(String)
+            action[:response][name] = { type: type_or_all }
+          end unless action[:response].blank?
+        end
+
+      end # Processor
+
+      class BootstrapRenderer
+
+        # Create a single HTML page enhanced
+        # by Twitter boostrap components.
+        #
+        def render(resources, embedded_resources)
+          source = File.read(self.path)
+          engine = Haml::Engine.new(source)
+          engine.render(Object.new, resources: resources, embedded_resources: embedded_resources)
+        end
+
+        protected
+
+        def path
+          File.join(File.dirname(__FILE__), 'api_documentation', 'bootstrap.html.haml')
+        end
+
+      end # BootstrapRenderer
+
+    end
+  end
+end

data/lib/locomotive/misc/api_documentation/bootstrap.html.haml

@@ -0,0 +1,196 @@
+!!! Strict
+%html
+  %title LocomotiveCMS Restful API
+
+  %link{ href: '//netdna.bootstrapcdn.com/twitter-bootstrap/2.1.1/css/bootstrap.no-icons.min.css', rel: 'stylesheet' }
+  %link{ href: '//netdna.bootstrapcdn.com/font-awesome/2.0/css/font-awesome.css', rel: 'stylesheet' }
+
+  %link{ href: '//netdna.bootstrapcdn.com/bootswatch/2.1.1/superhero/bootstrap.min.css', rel: 'stylesheet' }
+
+  %script{ src: '//ajax.googleapis.com/ajax/libs/jquery/1.8.3/jquery.min.js' }
+  %script{ src: '//netdna.bootstrapcdn.com/twitter-bootstrap/2.2.2/js/bootstrap.min.js' }
+
+  %body
+    .container
+      %header
+        %h1 LocomotiveCMS Restful API
+      .row
+        .span4
+          .well
+            %ul.nav.nav-list
+              - resources.each do |resource|
+                %li.nav-header= resource[:name].humanize
+                - resource[:actions].each do |name, info|
+                  %li
+                    %a{ href: "##{resource[:name].downcase}-#{name.downcase}" }
+                      = name
+                       
+                      - case info[:verb]
+                      - when 'GET'
+                        %span.label.label-info GET
+                      - when 'POST'
+                        %span.label.label-success POST
+                      - when 'PUT'
+                        %span.label.label-warning UPDATE
+                      - when 'DELETE'
+                        %span.label.label-important DELETE
+        .span8
+          - resources.each do |resource|
+            %h2= resource[:name].humanize
+
+            %p= resource[:overall]
+
+            %br
+
+            - resource[:actions].each do |name, info|
+              %h4{ id: "#{resource[:name].downcase}-#{name.downcase}" }
+                - case info[:verb]
+                - when 'GET'
+                  %span.label.label-info GET
+                - when 'POST'
+                  %span.label.label-success POST
+                - when 'PUT'
+                  %span.label.label-warning UPDATE
+                - when 'DELETE'
+                  %span.label.label-important DELETE
+
+                 
+                = info[:path]
+
+              .well
+
+                %p= info[:description]
+
+                - if info[:params] || (info[:example] && info[:example][:command])
+                  %h5
+                    %i.icon-signin
+                    Params
+
+                  - if info[:params].blank?
+                    %p None
+                  - else
+                    %table.table.table-bordered.table-striped.table-hover
+                      %tr
+                        %th Name
+                        %th Type
+                        %th Required
+                        %th Description
+                      - info[:params].each do |name, attributes|
+                        %tr
+                          %td
+                            - if attributes[:required]
+                              = name
+                            - else
+                              %i= name
+                            - unless attributes[:alias_of].blank?
+                              alias of
+                              %span.label.label-info= attributes[:alias_of]
+                          %td
+                            - if attributes[:type] == 'Array' && attributes[:collection_of]
+                              - name = attributes[:collection_of][:name]
+                              Collection of
+                              %a{ href: "##{name.dasherize}" }= name.humanize
+                            - elsif attributes[:alias_of]
+                              —
+                            - else
+                              = attributes[:type]
+                          %td
+                            - if attributes[:required]
+                              %i.icon-ok
+                            - else
+                              —
+                          %td= attributes[:description]
+
+                  - if info[:example] && info[:example][:command]
+                    %h6 Example
+                    %pre.prettyprint= info[:example][:command]
+
+                - if info[:response] || (info[:example] && info[:example][:response])
+                  %h5
+                    %i.icon-signout
+                    Response
+
+                  - if info[:response]
+                    %table.table.table-bordered.table-striped.table-hover
+                      %tr
+                        %th Name
+                        %th Type
+                        %th Description
+                      - info[:response].each do |name, attributes|
+                        %tr
+                          %td= name
+                          %td
+                            - if attributes[:type] == 'Array' && attributes[:collection_of]
+                              - name = attributes[:collection_of][:name]
+                              Collection of
+                              %a{ href: "##{name.dasherize}" }= name.humanize
+                            - elsif attributes[:alias_of]
+                              —
+                            - else
+                              = attributes[:type]
+                          %td= attributes[:description] || '—'
+
+                  - if info[:example] && info[:example][:response]
+                    %h6 Example
+                    %pre.prettyprint= info[:example][:response]
+
+              %br
+
+            %hr
+
+          %h2 Embedded resourcess
+
+          %br
+
+          - embedded_resources.each do |resource|
+            %h4{ id: resource[:name].dasherize }= resource[:name].humanize
+
+            .well
+              %ul.nav.nav-tabs
+                %li.active
+                  %a{ href: "##{resource[:name].dasherize}-getters", data: { toggle: 'tab' } } Out
+                %li
+                  %a{ href: "##{resource[:name].dasherize}-setters", data: { toggle: 'tab' } } In
+
+              .tab-content
+                - %w(getters setters).each do |type|
+                  .tab-pane{ id: "#{resource[:name].dasherize}-#{type}", class: "#{'active' if type == 'getters' }" }
+
+                    - list = resource[type.to_sym]
+
+                    %table.table.table-bordered.table-striped.table-hover
+                      %tr
+                        %th Name
+                        %th Type
+                        - if type == 'setters'
+                          %th Required
+                        %th Description
+                      - list.each do |name, attributes|
+                        %tr
+                          %td
+                            - if attributes[:required]
+                              = name
+                            - else
+                              %i= name
+                            - unless attributes[:alias_of].blank?
+                              %b alias of
+                              %span.label.label-info= attributes[:alias_of]
+                          %td
+                            - if attributes[:type] == 'Array' && attributes[:collection_of]
+                              - name = attributes[:collection_of][:name]
+                              Collection of
+                              %a{ href: "##{name.dasherize}" }= name.humanize
+                            - elsif attributes[:alias_of]
+                              —
+                            - else
+                              = attributes[:type]
+                          - if type == 'setters'
+                            %td
+                              - if attributes[:required]
+                                %i.icon-ok
+                              - else
+                                —
+                          %td= attributes[:description]
+
+            %hr
+