fae-railsz 2.1.0

data/db/migrate/20140822224029_create_fae_roles.rb

@@ -0,0 +1,10 @@
+class CreateFaeRoles < ActiveRecord::Migration[4.2]
+  def change
+    create_table :fae_roles do |t|
+      t.string :name
+      t.integer :position
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20141008180718_create_fae_images_table.rb

@@ -0,0 +1,19 @@
+class CreateFaeImagesTable < ActiveRecord::Migration[4.2]
+  def change
+    create_table(:fae_images) do |t|
+      t.string :name
+      t.string :asset
+      t.references :imageable, polymorphic: true, index: true
+      t.string :alt
+      t.string :caption
+      t.integer :position, default: 0
+      t.string :attached_as, index: true
+      t.boolean :on_stage, default: true
+      t.boolean :on_prod, default: false
+      t.integer :file_size
+      t.boolean :required, default: false
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20141017194616_create_fae_options.rb

@@ -0,0 +1,16 @@
+class CreateFaeOptions < ActiveRecord::Migration[4.2]
+  def change
+    create_table :fae_options do |t|
+      t.string :title
+      t.string :time_zone
+      t.string :colorway
+      t.string :stage_url
+      t.string :live_url
+      t.integer :singleton_guard
+
+      t.timestamps
+    end
+
+    add_index :fae_options, :singleton_guard, unique: true
+  end
+end

data/db/migrate/20141021181327_create_fae_files.rb

@@ -0,0 +1,17 @@
+class CreateFaeFiles < ActiveRecord::Migration[4.2]
+  def change
+    create_table :fae_files do |t|
+      t.string :name
+      t.string :asset
+      t.references :fileable, polymorphic: true, index: true
+      t.integer :file_size
+      t.integer :position, default: 0
+      t.string :attached_as, index: true
+      t.boolean :on_stage, default: true
+      t.boolean :on_prod, default: false
+      t.boolean :required, default: false
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20141021183047_create_fae_text_areas.rb

@@ -0,0 +1,16 @@
+class CreateFaeTextAreas < ActiveRecord::Migration[4.2]
+  def change
+    create_table :fae_text_areas do |t|
+      t.string :label
+      t.text :content
+      t.integer :position, default: 0, index: true
+      t.boolean :on_stage, default: true, index: true
+      t.boolean :on_prod, default: false, index: true
+      t.integer :contentable_id, index: true
+      t.string :contentable_type, index: true
+      t.string :attached_as, index: true
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20141021184311_create_fae_pages.rb

@@ -0,0 +1,13 @@
+class CreateFaePages < ActiveRecord::Migration[4.2]
+  def change
+    create_table :fae_static_pages do |t|
+      t.string :title
+      t.integer :position, default: 0
+      t.boolean :on_stage, default: true
+      t.boolean :on_prod, default: false
+      t.string :slug, index: true
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20141105214814_create_fae_text_fields.rb

@@ -0,0 +1,15 @@
+class CreateFaeTextFields < ActiveRecord::Migration[4.2]
+  def change
+    create_table :fae_text_fields do |t|
+      t.references :contentable, polymorphic: true, index: true
+      t.string :attached_as, index: true
+      t.string :label
+      t.string :content
+      t.integer :position, default: 0, index: true
+      t.boolean :on_stage, default: true, index: true
+      t.boolean :on_prod, default: false, index: true
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20150930224821_create_fae_changes.rb

@@ -0,0 +1,17 @@
+class CreateFaeChanges < ActiveRecord::Migration[4.2]
+  def change
+    create_table :fae_changes do |t|
+      t.integer :changeable_id
+      t.string :changeable_type
+      t.integer :user_id
+      t.string :change_type
+      t.text :updated_attributes
+
+      t.timestamps null: false
+    end
+
+    add_index :fae_changes, :changeable_id
+    add_index :fae_changes, :changeable_type
+    add_index :fae_changes, :user_id
+  end
+end

data/lib/fae-rails.rb

@@ -0,0 +1,6 @@
+require "fae/engine"
+require "fae/options"
+require 'carrierwave'
+
+module Fae
+end

data/lib/fae/concerns/models/base.rb

@@ -0,0 +1,8 @@
+# moved to app/models/concerns/fae/base_model_concern.rb
+# keep for backwards compatibility
+module Fae::Concerns::Models::Base
+  extend ActiveSupport::Concern
+  included do
+    include Fae::BaseModelConcern
+  end
+end

data/lib/fae/engine.rb

@@ -0,0 +1,37 @@
+require 'devise'
+
+module Fae
+  class Engine < ::Rails::Engine
+    isolate_namespace Fae
+
+    # include libraries
+    require 'simple_form'
+    require 'remotipart'
+    require 'jquery-rails'
+    require 'jquery-ui-rails'
+    require 'judge'
+    require 'judge/simple_form'
+    require 'acts_as_list'
+    require 'slim'
+    require 'kaminari'
+    require 'fae/version'
+
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    config.to_prepare do
+      # Require decorators from main application
+      Dir.glob(Rails.root.join('app', 'decorators', '**', '*_decorator.rb')).each do |decorator|
+        Rails.configuration.cache_classes ? require(decorator) : load(decorator)
+      end
+
+      ApplicationController.helper(ApplicationHelper)
+    end
+
+    config.generators do |g|
+      g.test_framework :rspec, fixture: false
+      g.fixture_replacement :factory_girl, dir: 'spec/factories'
+      g.assets false
+      g.helper false
+    end
+  end
+end

data/lib/fae/options.rb

@@ -0,0 +1,35 @@
+require 'devise'
+require 'judge'
+require_relative 'validation_helper_collection'
+
+module Fae
+  # configurable defaults
+  class << self
+    mattr_accessor :devise_secret_key, :devise_mailer_sender, :dashboard_exclusions, :max_image_upload_size, :max_file_upload_size, :languages, :recreate_versions, :validation_helpers, :track_changes, :tracker_history_length, :slug_separator, :disabled_environments, :per_page, :use_cache
+
+    self.devise_secret_key      = ''
+    self.devise_mailer_sender   = 'change-me@example.com'
+    self.dashboard_exclusions   = []
+    self.max_image_upload_size  = 2
+    self.max_file_upload_size   = 5
+    self.languages              = {}
+    self.recreate_versions      = false
+    self.validation_helpers     = ValidationHelperCollection.new
+    self.track_changes          = true
+    self.tracker_history_length = 15
+    self.slug_separator         = '-'
+    self.disabled_environments  = []
+    self.per_page               = 25
+    self.use_cache              = false
+  end
+
+  # this function maps the vars from your app into your engine
+  def self.setup(&block)
+    yield self
+
+    # assign initializer configs
+    Devise.secret_key = Fae.devise_secret_key
+    Devise.mailer_sender = Fae.devise_mailer_sender
+    Kaminari.config.default_per_page = Fae.per_page
+  end
+end

data/lib/fae/validation_helper_collection.rb

@@ -0,0 +1,76 @@
+class ValidationHelperCollection
+
+  def slug_regex
+    /\A[-_a-zA-Z0-9]+\z/
+  end
+
+  def email_regex
+    /\A\s*(([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})[\s\/,;]*)+\z/
+  end
+
+  def url_regex
+    /\A(https?:\/\/)/
+  end
+
+  def zip_regex
+    /\A(\d{5})?\z/
+  end
+
+  def youtube_regex
+    /[a-zA-Z0-9_-]{11}/
+  end
+
+  ### Complete Hash Validations
+
+  def slug
+    {
+      uniqueness: true,
+      presence: true,
+      format: {
+        with: self.slug_regex,
+        message: 'cannot have spaces or special characters'
+      }
+    }
+  end
+
+  def email
+    {
+      allow_blank: true,
+      format: {
+        with: self.email_regex,
+        message: 'is invalid'
+      }
+    }
+  end
+
+  def url
+    {
+      allow_blank: true,
+      format: {
+        with: self.url_regex,
+        message: 'is invalid'
+      }
+    }
+  end
+
+  def zip
+    {
+      allow_blank: true,
+      format: {
+        with: self.zip_regex,
+        message: 'is invalid'
+      }
+    }
+  end
+
+  def youtube_url
+    {
+      allow_blank: true,
+      format: {
+        with: self.youtube_regex,
+        message: 'is invalid'
+      }
+    }
+  end
+
+end

data/lib/fae/version.rb

@@ -0,0 +1,3 @@
+module Fae
+  VERSION = '2.1.0'
+end

data/lib/file_size_validator.rb

@@ -0,0 +1,71 @@
+# From https://gist.github.com/chrisbloom7/1009861 based on https://gist.github.com/795665
+
+class FileSizeValidator < ActiveModel::EachValidator
+  MESSAGES  = { :is => :wrong_size, :minimum => :size_too_small, :maximum => :size_too_big }.freeze
+  CHECKS    = { :is => :==, :minimum => :>=, :maximum => :<= }.freeze
+
+  DEFAULT_TOKENIZER = lambda { |value| value.split(//) }
+  RESERVED_OPTIONS  = [:minimum, :maximum, :within, :is, :tokenizer, :too_short, :too_long]
+
+  def initialize(options)
+    if range = (options.delete(:in) || options.delete(:within))
+      raise ArgumentError, ":in and :within must be a Range" unless range.is_a?(Range)
+      options[:minimum], options[:maximum] = range.begin, range.end
+      options[:maximum] -= 1 if range.exclude_end?
+    end
+
+    super
+  end
+
+  def check_validity!
+    keys = CHECKS.keys & options.keys
+
+    if keys.empty?
+      raise ArgumentError, 'Range unspecified. Specify the :within, :maximum, :minimum, or :is option.'
+    end
+
+    keys.each do |key|
+      value = options[key]
+
+      unless value.is_a?(Integer) && value >= 0
+        raise ArgumentError, ":#{key} must be a nonnegative Integer"
+      end
+    end
+  end
+
+  def validate_each(record, attribute, value)
+    raise(ArgumentError, "A CarrierWave::Uploader::Base object was expected") unless value.kind_of? CarrierWave::Uploader::Base
+
+    value = (options[:tokenizer] || DEFAULT_TOKENIZER).call(value) if value.kind_of?(String)
+
+    CHECKS.each do |key, validity_check|
+      next unless check_value = options[key]
+
+      value ||= [] if key == :maximum
+
+      begin
+        value_size = value.size
+        next if value_size.send(validity_check, check_value)
+      rescue
+        next
+      end
+
+      errors_options = options.except(*RESERVED_OPTIONS)
+      errors_options[:file_size] = help.number_to_human_size check_value
+
+      default_message = options[MESSAGES[key]]
+      errors_options[:message] ||= default_message if default_message
+
+      record.errors.add(attribute, MESSAGES[key], errors_options)
+    end
+  end
+  
+  def help
+    Helper.instance
+  end
+
+  class Helper
+    include Singleton
+    include ActionView::Helpers::NumberHelper
+  end
+end

data/lib/generators/fae/base_generator.rb

@@ -0,0 +1,156 @@
+module Fae
+  class BaseGenerator < Rails::Generators::NamedBase
+    source_root ::File.expand_path('../templates', __FILE__)
+    argument :attributes, type: :array, default: [], banner: "field[:type][:index] field[:type][:index]"
+    class_option :namespace, type: :string, default: 'admin', desc: 'Sets the namespace of the generator'
+    class_option :template, type: :string, default: 'slim', desc: 'Sets the template engine of the generator'
+
+    @@attributes_flat = []
+    @@attribute_names = []
+    @@association_names = []
+    @@attachments = []
+    @@has_position = false
+    @@display_field = ''
+
+    def check_template_support
+      supported_templates = ['slim']
+      raise "Fae::UnsupportedTemplate: the template engine you defined isn't supported" unless supported_templates.include?(options.template)
+    end
+
+    def set_globals
+      if attributes.present?
+        attributes.each do |arg|
+          # :image and :file args get used to generate association defs and form elements
+          # we don't want them in attributes_flat or attribute_names as they are not real model generator field options
+          if is_attachment(arg)
+            @@attachments << arg
+          else
+            @@attributes_flat << "#{arg.name}:#{arg.type}"
+          end
+
+          if arg.name['_id'] || arg.type.to_s == 'references'
+            @@association_names << arg.name.gsub('_id', '')
+          elsif !is_attachment(arg)
+            @@attribute_names << arg.name
+          end
+          @@has_position = true if arg.name === 'position'
+        end
+
+        @@attributes_flat = @@attributes_flat.uniq.join(' ')
+        @@association_names.uniq!
+        @@attribute_names.uniq!
+        @@attachments.uniq!
+      end
+    end
+
+  private
+
+    ## Generator Methods
+
+    def generate_model
+      generate "model #{file_name} #{@@attributes_flat}"
+      inject_concern
+      inject_display_field_to_model
+      inject_model_attachments
+      inject_position_scope
+    end
+
+    def generate_controller_file
+      @attachments = @@attachments
+      template "controllers/scaffold_controller.rb", "app/controllers/#{options.namespace}/#{file_name.pluralize}_controller.rb"
+    end
+
+    def generate_view_files
+      @toggle_attrs = set_toggle_attrs
+      @form_attrs = set_form_attrs
+      @association_names = @@association_names
+      @attachments = @@attachments
+      @has_position = @@has_position
+      @display_field = @@display_field
+      template "views/index.html.#{options.template}", "app/views/#{options.namespace}/#{plural_file_name}/index.html.#{options.template}"
+      template "views/_form.html.#{options.template}", "app/views/#{options.namespace}/#{plural_file_name}/_form.html.#{options.template}"
+      copy_file "views/new.html.#{options.template}", "app/views/#{options.namespace}/#{plural_file_name}/new.html.#{options.template}"
+      copy_file "views/edit.html.#{options.template}", "app/views/#{options.namespace}/#{plural_file_name}/edit.html.#{options.template}"
+    end
+
+    def add_route
+      inject_into_file "config/routes.rb", after: "namespace :#{options.namespace} do\n" do <<-RUBY
+    resources :#{plural_file_name}
+RUBY
+      end
+    end
+
+    ## Helper Methods
+
+    def set_toggle_attrs
+      ['active', 'on_stage', 'on_prod'] & @@attribute_names
+    end
+
+    def set_form_attrs
+      rejected_attrs = ['position', 'on_stage', 'on_prod']
+      @@attribute_names.delete_if { |i| rejected_attrs.include?(i)}
+    end
+
+    def inject_concern
+      inject_into_file "app/models/#{file_name}.rb", after: /(ActiveRecord::Base|ApplicationRecord)\n/ do <<-RUBY
+  include Fae::BaseModelConcern\n
+RUBY
+      end
+    end
+
+    def inject_display_field_to_model
+      if @@attribute_names.include? 'name'
+        @@display_field = 'name'
+      elsif @@attribute_names.include? 'title'
+        @@display_field = 'title'
+      end
+
+      inject_into_file "app/models/#{file_name}.rb", after: "include Fae::BaseModelConcern\n" do <<-RUBY
+  def fae_display_field
+    #{@@display_field}
+  end
+RUBY
+      end
+
+    end
+
+    def inject_position_scope
+      if @@has_position
+        inject_into_file "app/models/#{file_name}.rb", after: "include Fae::BaseModelConcern\n" do <<-RUBY
+\n  acts_as_list add_new_at: :top
+  default_scope { order(:position) }\n
+RUBY
+        end
+      end
+    end
+
+    def inject_model_attachments
+      return if @@attachments.blank?
+      @@attachments.each do |attachment|
+        if attachment.type == :image
+          inject_into_file "app/models/#{file_name}.rb", after: "include Fae::BaseModelConcern\n" do
+            <<-RUBY
+  has_fae_image :#{attachment.name}\n
+RUBY
+          end
+        elsif attachment.type == :file
+          inject_into_file "app/models/#{file_name}.rb", after: "include Fae::BaseModelConcern\n" do
+            <<-RUBY
+  has_fae_file :#{attachment.name}\n
+RUBY
+          end
+        end
+      end
+    end
+
+    def inject_nav_item
+      line = "item('#{plural_file_name.humanize.titlecase}', path: #{options.namespace}_#{plural_file_name}_path),\n\s\s\s\s\s\s\s\s"
+      inject_into_file 'app/models/concerns/fae/navigation_concern.rb', line, before: '# scaffold inject marker'
+    end
+
+    def is_attachment(arg)
+      [:image,:file].include?(arg.type)
+    end
+
+  end
+end