landable 1.13.1 → 1.13.2

data/app/services/landable/screenshot_service.rb

@@ -5,8 +5,8 @@ module Landable
     class Error < StandardError; end
 
     class << self
-      def capture url
-        if not Landable.configuration.publicist_url
+      def capture(url)
+        if !Landable.configuration.publicist_url
           Rails.logger.warn "Couldn't generate screenshot for #{url}; no Landable.configuration.publicist_url configured"
         else
           screenshots_uri = URI(Landable.configuration.publicist_url)
@@ -22,11 +22,10 @@ module Landable
 
             file
           else
-            raise Error, "Received #{response.code} back from #{screenshots_uri.to_s}"
+            fail Error, "Received #{response.code} back from #{screenshots_uri}"
           end
         end
       end
     end
-
   end
 end

data/app/services/landable/tidy_service.rb

@@ -1,10 +1,13 @@
 module Landable
   module TidyService
-
     class TidyError < StandardError; end
 
-    mattr_accessor :options
-    @@options = [
+    class << self
+      attr_accessor :options
+      attr_accessor :liquid_elements
+    end
+
+    @options = [
       # is what we have
       '-utf8',
 
@@ -31,28 +34,21 @@ module Landable
 
       # silence will fall
       '--quiet true',
-      '--show-warnings false',
+      '--show-warnings false'
     ]
 
     # list of liquid tags that also render tags - things that we should
     # consider to be element-level, and therefore to be tidied along with the
     # rest of the dom
-    mattr_accessor :liquid_elements
-    @@liquid_elements = [
-      'template',
-      'title_tag',
-      'meta_tags',
-      'img_tag',
-    ]
-
+    @liquid_elements = %w(template title_tag meta_tags img_tag)
 
-    def self.call! input
-      self.call input, raise_on_error: true
+    def self.call!(input)
+      call input, raise_on_error: true
     end
 
-    def self.call input, runtime_options={}
-      if not tidyable?
-        raise TidyError, 'Your system doesn\'t seem to have tidy installed. Please see https://github.com/w3c/tidy-html5.'
+    def self.call(input, runtime_options = {})
+      unless tidyable?
+        fail TidyError, 'Your system doesn\'t seem to have tidy installed. Please see https://github.com/w3c/tidy-html5.'
       end
 
       # wrapping known liquid in a span to allow tidy to format them nicely
@@ -70,8 +66,8 @@ module Landable
       # 2: error
       # 3: ???
       # 4: profit
-      if $?.exitstatus >= 2 and runtime_options[:raise_on_error]
-        raise TidyError, "Tidy exited with status #{$?} - check stderr."
+      if $CHILD_STATUS.exitstatus >= 2 && runtime_options[:raise_on_error]
+        fail TidyError, "Tidy exited with status #{$CHILD_STATUS} - check stderr."
       end
 
       # unnwrapping the liquid that we wrapped earlier
@@ -82,12 +78,12 @@ module Landable
     end
 
     def self.tidyable?
-      @@is_tidyable ||= Kernel.system('which tidy > /dev/null')
+      @is_tidyable ||= Kernel.system('which tidy > /dev/null')
     end
 
     protected
 
-    def self.wrap_liquid input
+    def self.wrap_liquid(input)
       output = input.dup
 
       output.scan(/(\s*(\{% *(?:#{liquid_elements.join('|')}) *.*?%})\s*)/).each do |match, liquid|
@@ -100,10 +96,10 @@ module Landable
       output
     end
 
-    def self.unwrap_liquid input
+    def self.unwrap_liquid(input)
       output = input.dup
 
-      output.scan(/(<div data-liquid="(.*?)"><\/div>)/).each do |match, liquid|
+      output.scan(%r{(<div data-liquid="(.*?)"><\/div>)}).each do |match, liquid|
         # ensure we match utf8 for utf8
         decoded = Base64.decode64(liquid).force_encoding(match.encoding)
         output.gsub! match, decoded
@@ -112,9 +108,8 @@ module Landable
       output
     end
 
-
     class Result < Object
-      def initialize source
+      def initialize(source)
         @source = source
       end
 
@@ -123,33 +118,33 @@ module Landable
       end
 
       def body
-        if match = @source.match(/<body(?: [^>]*)?>(.*)<\/body>/m)
-          deindent match[1]
-        end
+        match = @source.match(%r{<body(?: [^>]*)?>(.*)<\/body>}m)
+        return unless match
+        deindent match[1]
       end
 
       def head
-        if match = @source.match(/<head>(.*)<\/head>/m)
-          deindent match[1]
-        end
+        match = @source.match(%r{<head>(.*)<\/head>}m)
+        return unless match
+        deindent match[1]
       end
 
       def css
-        links = head.try :scan, /<link [^>]*type=['"]text\/css['"][^>]*>/
-        styles = head.try :scan, /<style[^>]*>.*?<\/style>/m
+        links = head.try :scan, %r{<link [^>]*type=['"]text\/css['"][^>]*>}
+        styles = head.try :scan, %r{<style[^>]*>.*?<\/style>}m
         [links.to_a, styles.to_a].flatten.join("\n\n")
       end
 
       protected
 
-      def deindent string
-        if match = string.match(/^([ \t]*)[^\s]/)
+      def deindent(string)
+        match = string.match(/^([ \t]*)[^\s]/)
+        if match
           string.gsub(/^#{match[1]}/, '').strip
         else
           string.strip
         end
       end
     end
-
   end
-end
+end

data/app/validators/path_validator.rb

@@ -1,8 +1,6 @@
 class PathValidator < ActiveModel::Validator
   def validate(record)
-    if match?(record.path)
-      record.errors[:path] << "is Reserved!"
-    end
+    record.errors[:path] << 'is Reserved!' if match?(record.path)
   end
 
   def match?(path)

data/app/validators/url_validator.rb

@@ -1,13 +1,10 @@
 class UrlValidator < ActiveModel::EachValidator
-
   def validate_each(record, attribute, value)
     valid = begin
-      value =~ /^[a-z]+\:\/\// or value =~ /^\//
+      value =~ %r{^[a-z]+\:\/\/} || value =~ %r{^\/}
     end
+    return if valid
 
-    unless valid
-      record.errors[attribute] << ("Invalid URL! Make sure it starts with http:// or /")
-    end
+    record.errors[attribute] << ('Invalid URL! Make sure it starts with http:// or /')
   end
-
-end
+end

data/config/routes.rb

@@ -4,7 +4,7 @@ Landable::Engine.routes.draw do
     resources :categories, only: [:index, :show]
 
     resources :directories, only: [:index, :show], constraints: {
-      id: /[%a-zA-Z0-9\/_.~-]*/
+      id: %r{[%a-zA-Z0-9\/_.~-]*}
     }
 
     resources :assets, only: [:index, :show, :create, :update, :deactivate, :destroy]
@@ -50,7 +50,6 @@ Landable::Engine.routes.draw do
 
     resources :access_tokens, only: [:create, :destroy, :show]
 
-
     # coming soon: screenshots!
 
     # resources :screenshots, only: [:index, :show, :create] do
@@ -69,9 +68,7 @@ Landable::Engine.routes.draw do
 
     get '/sitemap.xml' => 'sitemap#index', as: :sitemap
 
-    get '*url' => 'pages#show', as: :page, format: false, constraints: lambda { |request|
-      # Published Landable Page
-      Landable::PageRevision.table_exists? && Landable::PageRevision.where(path: request.path, is_published: true).any?
-    }
+    constraint = ->(request) { Landable::PageRevision.table_exists? && Landable::PageRevision.where(path: request.path, is_published: true).any? }
+    get '*url' => 'pages#show', as: :page, format: false, constraints: constraint
   end
 end

data/db/migrate/20130510221424_create_landable_schema.rb

@@ -3,21 +3,20 @@ class CreateLandableSchema < Landable::Migration
     # This really should not be in this migration, but it's a convenient location
     # while everything's still under development.
     #
-    # TODO extract to a separate migration, check if it exists, maybe check if we
+    # TODO: extract to a separate migration, check if it exists, maybe check if we
     # actually have permission to do it, etc.
     execute 'CREATE EXTENSION "uuid-ossp";'
-    enable_extension "uuid-ossp"
-    enable_extension "hstore"
-    enable_extension "pg_trgm"
+    enable_extension 'uuid-ossp'
+    enable_extension 'hstore'
+    enable_extension 'pg_trgm'
 
     execute 'ALTER EXTENSION "uuid-ossp" SET SCHEMA "public";'
     execute "CREATE SCHEMA #{Landable.configuration.database_schema_prefix}landable;"
 
-
     ## status_codes
 
     create_table "#{Landable.configuration.database_schema_prefix}landable.status_code_categories", id: :uuid, primary_key: :status_code_category_id do |t|
-      t.text      :name, null: false
+      t.text :name, null: false
     end
 
     execute "CREATE UNIQUE INDEX #{Landable.configuration.database_schema_prefix}landable_status_code_categories__u_name ON #{Landable.configuration.database_schema_prefix}landable.status_code_categories(lower(name))"
@@ -25,9 +24,9 @@ class CreateLandableSchema < Landable::Migration
               $$Categories that status codes belong to.  Used to affect behavior when viewing a page.$$"
 
     create_table "#{Landable.configuration.database_schema_prefix}landable.status_codes", id: :uuid, primary_key: :status_code_id do |t|
-      t.uuid      :status_code_category_id, null: false
-      t.integer   :code,                    null: false, limit: 2 # Creates as smallint
-      t.text      :description,             null: false
+      t.uuid :status_code_category_id, null: false
+      t.integer :code,                    null: false, limit: 2 # Creates as smallint
+      t.text :description,             null: false
     end
 
     execute "CREATE UNIQUE INDEX #{Landable.configuration.database_schema_prefix}landable_status_codes__u_code ON #{Landable.configuration.database_schema_prefix}landable.status_codes(code)"
@@ -35,7 +34,6 @@ class CreateLandableSchema < Landable::Migration
     execute "COMMENT ON TABLE #{Landable.configuration.database_schema_prefix}landable.status_codes IS
               $$Allowed status codes that pages can be set to.$$"
 
-
     ## themes
 
     create_table "#{Landable.configuration.database_schema_prefix}landable.themes", id: :uuid, primary_key: :theme_id do |t|
@@ -50,7 +48,6 @@ class CreateLandableSchema < Landable::Migration
     execute "COMMENT ON TABLE #{Landable.configuration.database_schema_prefix}landable.themes IS
               $$Created themes to be consumed by pages.  Themes supply formatting (css) rules and can supply header/footer content as well.$$"
 
-
     ## templates
 
     create_table "#{Landable.configuration.database_schema_prefix}landable.templates", id: :uuid, primary_key: :template_id do |t|
@@ -65,28 +62,28 @@ class CreateLandableSchema < Landable::Migration
 
     execute "CREATE UNIQUE INDEX #{Landable.configuration.database_schema_prefix}landable_templates__u_name ON #{Landable.configuration.database_schema_prefix}landable.templates(lower(name))"
     execute "COMMENT ON TABLE #{Landable.configuration.database_schema_prefix}landable.templates IS
-              $$Created templates to be consumed by pages. 
-              A template can supply 'starter' code for a page. 
+              $$Created templates to be consumed by pages.
+              A template can supply 'starter' code for a page.
               A template can also supply code to create elements on a page (sidebars, for example).$$"
 
     ## pages
 
     create_table "#{Landable.configuration.database_schema_prefix}landable.pages", id: :uuid, primary_key: :page_id do |t|
-      t.uuid      :published_revision_id
-      t.boolean   :is_publishable, null: false, default: true
+      t.uuid :published_revision_id
+      t.boolean :is_publishable, null: false, default: true
 
-      t.uuid      :theme_id
-      t.uuid      :category_id
-      t.uuid      :status_code_id, null: false
+      t.uuid :theme_id
+      t.uuid :category_id
+      t.uuid :status_code_id, null: false
 
-      t.text      :path, null: false
+      t.text :path, null: false
 
-      t.text      :title
-      t.text      :body
+      t.text :title
+      t.text :body
 
-      t.text      :redirect_url
+      t.text :redirect_url
 
-      t.hstore    :meta_tags
+      t.hstore :meta_tags
 
       t.timestamp :imported_at
       t.timestamps
@@ -123,11 +120,10 @@ class CreateLandableSchema < Landable::Migration
     execute "COMMENT ON TABLE #{Landable.configuration.database_schema_prefix}landable.authors IS
               $$A list of authors that have accessed the website.  Feeds foreign keys so we know which authors have published pages and updated assets.$$"
 
-
     ## access_tokens
 
     create_table "#{Landable.configuration.database_schema_prefix}landable.access_tokens", id: :uuid, primary_key: :access_token_id do |t|
-      t.uuid      :author_id,  null: false
+      t.uuid :author_id,  null: false
       t.timestamp :expires_at, null: false
       t.timestamps
     end
@@ -137,19 +133,18 @@ class CreateLandableSchema < Landable::Migration
     execute "COMMENT ON TABLE #{Landable.configuration.database_schema_prefix}landable.access_tokens IS
               $$Access tokens provide authentication information for specific users.$$"
 
-
     ## page_revisions
 
     create_table "#{Landable.configuration.database_schema_prefix}landable.page_revisions", id: :uuid, primary_key: :page_revision_id do |t|
-      t.integer   :ordinal
-      t.text      :notes
-      t.boolean   :is_minor,      default: false
-      t.boolean   :is_published,  default: true
+      t.integer :ordinal
+      t.text :notes
+      t.boolean :is_minor,      default: false
+      t.boolean :is_published,  default: true
 
-      t.uuid      :page_id,   null: false
-      t.uuid      :author_id, null: false
+      t.uuid :page_id,   null: false
+      t.uuid :author_id, null: false
 
-      t.text      :snapshot_attributes, null: false
+      t.text :snapshot_attributes, null: false
 
       t.timestamps
     end
@@ -159,12 +154,11 @@ class CreateLandableSchema < Landable::Migration
               The attributes of the page at the time of publishing are stored in snapshot_attributes, as essentially a text representation of a hash.
               The current/active/live revision can be identified by referring to its corresponding PAGES record, OR by looking for the max(ordinal) for a given page_id.$$"
 
-
     ## categories
 
     create_table "#{Landable.configuration.database_schema_prefix}landable.categories", id: :uuid, primary_key: :category_id do |t|
-      t.text      :name
-      t.text      :description
+      t.text :name
+      t.text :description
     end
 
     execute "CREATE UNIQUE INDEX #{Landable.configuration.database_schema_prefix}landable_categories__u_name ON #{Landable.configuration.database_schema_prefix}landable.categories(lower(name))"
@@ -172,16 +166,15 @@ class CreateLandableSchema < Landable::Migration
               $$Categories are used to sort pages.
               Examples could include SEO, PPC.$$"
 
-
     ## assets
 
     create_table "#{Landable.configuration.database_schema_prefix}landable.assets", id: :uuid, primary_key: :asset_id do |t|
-      t.uuid    :author_id,   null: false
-      t.text    :name,        null: false
-      t.text    :description
-      t.text    :data,        null: false
-      t.text    :md5sum,      null: false, length: 32
-      t.text    :mime_type,   null: false
+      t.uuid :author_id,   null: false
+      t.text :name,        null: false
+      t.text :description
+      t.text :data,        null: false
+      t.text :md5sum,      null: false, length: 32
+      t.text :mime_type,   null: false
       t.integer :file_size
       t.timestamps
     end
@@ -197,7 +190,6 @@ class CreateLandableSchema < Landable::Migration
               Examples of assets include images (jpg, png, gif) and documents (PDF).
               data, md5sum, mime_type, file_size are populated via the rails gem CarrierWave when a record is created.$$"
 
-
     ## browsers
 
     create_table "#{Landable.configuration.database_schema_prefix}landable.browsers", id: :uuid, primary_key: :browser_id do |t|
@@ -215,7 +207,6 @@ class CreateLandableSchema < Landable::Migration
 
     execute "CREATE INDEX #{Landable.configuration.database_schema_prefix}landable_screenshots__device_browser_browser_version ON #{Landable.configuration.database_schema_prefix}landable.browsers(device, browser, browser_version)"
 
-
     ## screenshots
 
     create_table "#{Landable.configuration.database_schema_prefix}landable.screenshots", id: :uuid, primary_key: :screenshot_id do |t|
@@ -241,7 +232,6 @@ class CreateLandableSchema < Landable::Migration
     execute "COMMENT ON TABLE #{Landable.configuration.database_schema_prefix}landable.screenshots IS
               $$Stores saved screenshots (taken of pages) and the URLs to retrieve the actual image.$$"
 
-
     ## asset associations table
 
     create_table "#{Landable.configuration.database_schema_prefix}landable.page_assets", id: :uuid, primary_key: :page_asset_id do |t|
@@ -305,9 +295,9 @@ class CreateLandableSchema < Landable::Migration
        $TRIGGER$
        LANGUAGE plpgsql;"
 
-      execute "CREATE TRIGGER #{Landable.configuration.database_schema_prefix}landable_page_revisions__bfr_insert
-              BEFORE INSERT ON #{Landable.configuration.database_schema_prefix}landable.page_revisions
-              FOR EACH ROW EXECUTE PROCEDURE #{Landable.configuration.database_schema_prefix}landable.pages_revision_ordinal();"
+    execute "CREATE TRIGGER #{Landable.configuration.database_schema_prefix}landable_page_revisions__bfr_insert
+            BEFORE INSERT ON #{Landable.configuration.database_schema_prefix}landable.page_revisions
+            FOR EACH ROW EXECUTE PROCEDURE #{Landable.configuration.database_schema_prefix}landable.pages_revision_ordinal();"
 
     # Trigger disallowing deletes on page_revisions
     execute "CREATE FUNCTION #{Landable.configuration.database_schema_prefix}landable.tg_disallow()
@@ -328,13 +318,12 @@ class CreateLandableSchema < Landable::Migration
        $TRIGGER$
        LANGUAGE plpgsql;"
 
-      execute "CREATE TRIGGER #{Landable.configuration.database_schema_prefix}landable_page_revisions__no_delete
-              BEFORE DELETE ON #{Landable.configuration.database_schema_prefix}landable.page_revisions
-              FOR EACH STATEMENT EXECUTE PROCEDURE #{Landable.configuration.database_schema_prefix}landable.tg_disallow();"
-
-      execute "CREATE TRIGGER #{Landable.configuration.database_schema_prefix}landable_page_revisions__no_update
-              BEFORE UPDATE OF notes, is_minor, page_id, author_id, created_at, ordinal ON #{Landable.configuration.database_schema_prefix}landable.page_revisions
-              FOR EACH STATEMENT EXECUTE PROCEDURE #{Landable.configuration.database_schema_prefix}landable.tg_disallow();"
+    execute "CREATE TRIGGER #{Landable.configuration.database_schema_prefix}landable_page_revisions__no_delete
+            BEFORE DELETE ON #{Landable.configuration.database_schema_prefix}landable.page_revisions
+            FOR EACH STATEMENT EXECUTE PROCEDURE #{Landable.configuration.database_schema_prefix}landable.tg_disallow();"
 
+    execute "CREATE TRIGGER #{Landable.configuration.database_schema_prefix}landable_page_revisions__no_update
+            BEFORE UPDATE OF notes, is_minor, page_id, author_id, created_at, ordinal ON #{Landable.configuration.database_schema_prefix}landable.page_revisions
+            FOR EACH STATEMENT EXECUTE PROCEDURE #{Landable.configuration.database_schema_prefix}landable.tg_disallow();"
   end
 end