forest_cms 0.98.1

data/lib/forest/rails/core_ext/enumerable.rb

@@ -0,0 +1,17 @@
+module Enumerable
+  # clumps adjacent elements together
+  # >> [2,2,2,3,3,4,2,2,1].cluster{|x| x}
+  # => [[2, 2, 2], [3, 3], [4], [2, 2], [1]]
+  # http://apidock.com/rails/Enumerable/group_by#508-Array-clustering
+  def cluster
+    cluster = []
+    each do |element|
+      if cluster.last && yield(cluster.last.last) == yield(element)
+        cluster.last << element
+      else
+        cluster << [element]
+      end
+    end
+    cluster
+  end
+end

data/lib/forest/version.rb

@@ -0,0 +1,3 @@
+module Forest
+  VERSION = '0.98.1'
+end

data/lib/generators/forest/block/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates a migration to create a new block type.
+
+Example:
+    rails generate block TitleBlock
+
+    This will create:
+        TODO

data/lib/generators/forest/block/block_generator.rb

@@ -0,0 +1,103 @@
+class Forest::BlockGenerator < Rails::Generators::NamedBase
+  include Rails::Generators::Migration
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  argument :attributes, type: :array, default: [], banner: "field[:type][:index] field[:type][:index]"
+
+  def self.next_migration_number(dirname)
+    next_migration_number = current_migration_number(dirname) + 1
+    ActiveRecord::Migration.next_migration_number(next_migration_number)
+  end
+
+  def create_model_file
+    template 'model.rb', File.join('app/models/blocks', "#{file_name}.rb")
+  end
+
+  def create_view_files
+    template "_block.html.erb", File.join('app/views/blocks', file_name, "_show.html.erb")
+    template "_block_edit_fields.html.erb", File.join('app/views/blocks', file_name, "_edit.html.erb")
+  end
+
+  def create_migration_file
+    set_local_assigns!
+    validate_file_name!
+    migration_template 'create_table_migration.rb', "db/migrate/create_#{table_name}.rb"
+  end
+
+  def create_stylesheet
+    template '_block.scss.erb', File.join('app/assets/stylesheets/blocks', "_#{file_name}.scss")
+  end
+
+  private
+
+    attr_reader :migration_action, :join_tables
+
+    # Sets the default migration template that is being used for the generation of the migration.
+    # Depending on command line arguments, the migration template and the table name instance
+    # variables are set up.
+    def set_local_assigns!
+      @migration_template = "migration.rb"
+      case file_name
+      when /^(add|remove)_.*_(?:to|from)_(.*)/
+        @migration_action = $1
+        @table_name       = normalize_table_name($2)
+      when /join_table/
+        if attributes.length == 2
+          @migration_action = "join"
+          @join_tables      = pluralize_table_names? ? attributes.map(&:plural_name) : attributes.map(&:singular_name)
+
+          set_index_names
+        end
+      when /^create_(.+)/
+        @table_name = normalize_table_name($1)
+        @migration_template = "create_table_migration.rb"
+      end
+    end
+
+    def set_index_names
+      attributes.each_with_index do |attr, i|
+        attr.index_name = [attr, attributes[i - 1]].map { |a| index_name_for(a) }
+      end
+    end
+
+    def index_name_for(attribute)
+      if attribute.foreign_key?
+        attribute.name
+      else
+        attribute.name.singularize.foreign_key
+      end.to_sym
+    end
+
+    def attributes_with_index
+      attributes.select { |a| !a.reference? && a.has_index? }
+    end
+
+    # A migration file name can only contain underscores (_), lowercase characters,
+    # and numbers 0-9. Any other file name will raise an IllegalMigrationNameError.
+    def validate_file_name!
+      unless /^[_a-z0-9]+$/.match?(file_name)
+        raise IllegalMigrationNameError.new(file_name)
+      end
+    end
+
+    def normalize_table_name(_table_name)
+      pluralize_table_names? ? _table_name.pluralize : _table_name.singularize
+    end
+
+    def block_record_type
+      escape_quotes (ENV['BLOCK_RECORD_TYPE'].presence || 'default')
+    end
+
+    def block_category
+      escape_quotes (ENV['BLOCK_CATEGORY'].presence || 'default')
+    end
+
+    def block_description
+      escape_quotes (ENV['BLOCK_DESCRIPTION'].presence || '')
+    end
+
+    def escape_quotes(string)
+      string.gsub(/[']/, '\\\\\'')
+    end
+end

data/lib/generators/forest/block/templates/_block.html.erb

@@ -0,0 +1,2 @@
+<p><%%= block.class.name %> <%%= block.id %></p>
+<p>Find me in /app/views/blocks/<%%= block.model_name.singular %>/_show.html.erb</p>

data/lib/generators/forest/block/templates/_block.scss.erb

@@ -0,0 +1,5 @@
+// <%= singular_name.titleize %>
+
+.<%= singular_name.dasherize %> {
+
+}

data/lib/generators/forest/block/templates/_block_edit_fields.html.erb

@@ -0,0 +1,21 @@
+<%- if attributes.present? -%>
+  <%- attributes.each do |attribute| -%>
+    <%- if attribute.reference? -%>
+      <%- if attribute.name =~ /media_item/ -%>
+<%%= f.association :<%= attribute.name %>, as: :image %>
+      <%- else -%>
+<%%= f.association :<%= attribute.name %> %>
+      <%- end -%>
+    <%- else -%>
+      <%- if attribute.name =~ /date/ -%>
+<%%= f.input :<%= attribute.name %>, as: :datepicker %>
+      <%- elsif attribute.name =~ /text/ -%>
+<%%= f.input :<%= attribute.name %>, markdown: true %>
+      <%- else -%>
+<%%= f.input :<%= attribute.name %> %>
+      <%- end -%>
+    <%- end -%>
+  <%- end -%>
+<%- else -%>
+<%%#= f.input :attribute_name %>
+<%- end -%>

data/lib/generators/forest/block/templates/create_table_migration.rb

@@ -0,0 +1,31 @@
+class <%= migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    create_table :<%= table_name %> do |t|
+<% attributes.each do |attribute| -%>
+      t.<%= attribute.type %> :<%= attribute.name %><%= attribute.inject_options %>
+<% end -%>
+      t.timestamps
+    end
+<% attributes.select(&:token?).each do |attribute| -%>
+    add_index :<%= table_name %>, :<%= attribute.index_name %><%= attribute.inject_index_options %>, unique: true
+<% end -%>
+<% attributes_with_index.each do |attribute| -%>
+    add_index :<%= table_name %>, :<%= attribute.index_name %><%= attribute.inject_index_options %>
+<% end -%>
+
+    reversible do |change|
+      change.up do
+        unless BlockKind.find_by_name('<%= class_name %>')
+          BlockKind.create name: '<%= class_name %>',
+                           record_type: '<%= block_record_type %>',
+                           category: '<%= block_category %>',
+                           description: '<%= block_description %>'
+        end
+      end
+
+      change.down do
+        BlockKind.where(name: '<%= class_name %>').destroy_all
+      end
+    end
+  end
+end

data/lib/generators/forest/block/templates/model.rb

@@ -0,0 +1,41 @@
+<% module_namespacing do -%>
+class <%= class_name %> < BaseBlock
+<% attributes.each do |attribute| %><% if attribute.reference? -%>
+  belongs_to :<%= attribute.name %>
+
+<% end -%><% end -%>
+  def self.permitted_params
+    [<%= attributes.collect { |attribute| ":#{attribute.column_name}" }.join(', ') %>]
+  end
+
+  def self.display_name
+    '<%= class_name.titleize %>'
+  end
+
+<% if class_name.match(/image/i) -%>
+  def self.display_icon
+    'glyphicon glyphicon-picture'
+  end
+<% elsif class_name.match(/video/i) -%>
+  def self.display_icon
+    'glyphicon glyphicon-play'
+  end
+<% elsif class_name.match(/title/i) -%>
+  def self.display_icon
+    'glyphicon glyphicon-font'
+  end
+<% elsif class_name.match(/text/i) -%>
+  def self.display_icon
+    'glyphicon glyphicon-align-left'
+  end
+<% elsif class_name.match(/accordion/i) -%>
+  def self.display_icon
+    'glyphicon glyphicon-th-list'
+  end
+<% else -%>
+  # def self.display_icon
+  #   'glyphicon glyphicon-align-left'
+  # end
+<% end -%>
+end
+<% end -%>

data/lib/generators/forest/install/USAGE

@@ -0,0 +1,2 @@
+Description:
+    Forest ininitialization.

data/lib/generators/forest/install/install_generator.rb

@@ -0,0 +1,72 @@
+module Forest
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      # TODO: the install generator should:
+      #   - seed default settings
+      #     - block kinds
+      #   - install forest's migrations, or prompt the user to do this
+
+      puts "[Forest] Install Generator"
+
+      # Prompt to install migrations
+      if ActiveRecord::Base.connection.table_exists? 'settings'
+        puts "[Forest] -- Seeding database"
+
+        # Settings
+        puts "[Forest] ---- Creating default settings"
+
+        if Setting.find_by_title('Site Title').blank?
+          Setting.create(title: 'Site Title', value: 'Default Site Title', value_type: 'string')
+        end
+
+        if Setting.find_by_title('Description').blank?
+          Setting.create(title: 'Description', value: 'A Site Built With Forest')
+        end
+
+        if Setting.find_by_title('Featured Image').blank?
+          Setting.create(title: 'Featured Image', value: nil, value_type: 'image', description: "The featured image may be used when sharing the site on social media.")
+        end
+
+        # TODO
+        # if Setting.find_by_title('Locales').blank?
+        #   Setting.create(title: 'Locales', value: [:en], value_type: 'array')
+        # end
+
+        # User groups
+        puts "[Forest] ---- Creating user groups"
+
+        UserGroup.find_or_create_by(name: 'admin')
+        UserGroup.find_or_create_by(name: 'editor')
+        UserGroup.find_or_create_by(name: 'contributor')
+
+        # Block layouts
+        puts "[Forest] ---- Creating default block layouts"
+        if BlockLayout.find_by_slug('default').blank?
+          BlockLayout.create(slug: 'default', display_name: 'Content Blocks', description: "")
+        end
+
+        puts "[Forest]"
+        puts "[Forest] 🌲  all done!"
+        puts "[Forest]"
+        puts "[Forest] Post-install"
+
+        # Application config
+        puts "[Forest] -- Add the following to application.rb"
+        puts '[Forest] config.autoload_paths << "#{config.root}/app/models/blocks"'
+
+        # Create your first block
+        puts "[Forest] -- Create a Block by running this command:"
+        puts '[Forest] rails g forest:block TextBlock text:text'
+
+        # Visit the site and create an admin user
+        puts "[Forest] -- Visit the admin area of the website at localhost:3000/admin to create the admin user."
+      else
+        puts "[Forest] -- ✋  Import Forest's migrations by running the following command."
+        puts "[Forest] -- After installing migrations, run this generator again to seed the database."
+        puts "[Forest] rails railties:install:migrations"
+      end
+    end
+  end
+end

data/lib/generators/forest/scaffold/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates a Forest scaffold for a new object type.
+
+Example:
+    rails generate scaffold Artist first_name:string last_name:string bio:text
+
+    This will create:
+        TODO

data/lib/generators/forest/scaffold/scaffold_generator.rb

@@ -0,0 +1,133 @@
+require "rails/generators/rails/resource/resource_generator"
+
+class Forest::ScaffoldGenerator < Rails::Generators::NamedBase
+  include Rails::Generators::Migration
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  argument :attributes, type: :array, default: [], banner: "field[:type][:index] field[:type][:index]"
+  class_option :skip_public, type: :boolean, default: false, description: 'Skip public controller and views'
+  class_option :skip_blockable, type: :boolean, default: false, description: 'Skip blockable concern'
+  class_option :skip_statusable, type: :boolean, default: false, description: 'Skip statusable concern'
+  class_option :skip_sluggable, type: :boolean, default: false, description: 'Skip sluggable concern'
+
+  def self.next_migration_number(dirname)
+    next_migration_number = current_migration_number(dirname) + 1
+    ActiveRecord::Migration.next_migration_number(next_migration_number)
+  end
+
+  def create_model_file
+    template 'model.rb', File.join('app/models', "#{file_name}.rb")
+  end
+
+  def create_view_files
+    admin_views.each do |view|
+      filename = "#{view}.html.erb"
+      template "views/admin/#{filename}", File.join("app/views/admin", plural_name, filename)
+    end
+
+    template "views/admin/index.json.jbuilder", File.join("app/views/admin", plural_name, 'index.json.jbuilder')
+
+    unless options.skip_public?
+      public_views.each do |view|
+        filename = "#{view}.html.erb"
+        template "views/public/#{filename}", File.join("app/views", plural_name, filename)
+      end
+    end
+  end
+
+  def create_migration_file
+    set_local_assigns!
+    validate_file_name!
+    migration_template 'create_table_migration.rb', "db/migrate/create_#{table_name}.rb"
+  end
+
+  def create_controller
+    template 'admin_controller.rb', "app/controllers/admin/#{plural_name}_controller.rb"
+
+    unless options.skip_public?
+      template 'controller.rb', "app/controllers/#{plural_name}_controller.rb"
+    end
+
+    route_lines = []
+    route_lines << "# TODO: sort these new admin routes"
+    route_lines << "namespace :admin do"
+    route_lines << "  resources :#{plural_name}"
+    route_lines << "end\n"
+
+    unless options.skip_public?
+      route_lines << "# TODO: sort these new public routes"
+      route_lines << "resources :#{plural_name}, only: [:index, :show]\n\n"
+    end
+
+    route route_lines.join("\n")
+  end
+
+  def create_policy
+    template 'policy.rb', "app/policies/#{singular_name}_policy.rb"
+  end
+
+  private
+
+    attr_reader :migration_action, :join_tables
+
+    # Sets the default migration template that is being used for the generation of the migration.
+    # Depending on command line arguments, the migration template and the table name instance
+    # variables are set up.
+    def set_local_assigns!
+      @migration_template = "migration.rb"
+      case file_name
+      when /^(add|remove)_.*_(?:to|from)_(.*)/
+        @migration_action = $1
+        @table_name       = normalize_table_name($2)
+      when /join_table/
+        if attributes.length == 2
+          @migration_action = "join"
+          @join_tables      = pluralize_table_names? ? attributes.map(&:plural_name) : attributes.map(&:singular_name)
+
+          set_index_names
+        end
+      when /^create_(.+)/
+        @table_name = normalize_table_name($1)
+        @migration_template = "create_table_migration.rb"
+      end
+    end
+
+    def set_index_names
+      attributes.each_with_index do |attr, i|
+        attr.index_name = [attr, attributes[i - 1]].map { |a| index_name_for(a) }
+      end
+    end
+
+    def index_name_for(attribute)
+      if attribute.foreign_key?
+        attribute.name
+      else
+        attribute.name.singularize.foreign_key
+      end.to_sym
+    end
+
+    def attributes_with_index
+      attributes.select { |a| !a.reference? && a.has_index? }
+    end
+
+    # A migration file name can only contain underscores (_), lowercase characters,
+    # and numbers 0-9. Any other file name will raise an IllegalMigrationNameError.
+    def validate_file_name!
+      unless /^[_a-z0-9]+$/.match?(file_name)
+        raise IllegalMigrationNameError.new(file_name)
+      end
+    end
+
+    def normalize_table_name(_table_name)
+      pluralize_table_names? ? _table_name.pluralize : _table_name.singularize
+    end
+
+    def admin_views
+      %w(_form edit index new show)
+    end
+
+    def public_views
+      %w(index show)
+    end
+end