cambium 0.3.0 → 1.0.0

data/lib/generators/cambium/admin_generator.rb

@@ -0,0 +1,104 @@
+require 'rake'
+require 'rails/generators'
+require 'fileutils'
+require File.expand_path('../../helpers/_autoloader.rb', __FILE__)
+
+module Cambium
+  class AdminGenerator < Rails::Generators::Base
+
+    desc "Installs the base for a CMS within your rails application."
+
+    source_root File.expand_path('../../templates', __FILE__)
+
+    class_option(
+      :config_check,
+      :type => :boolean,
+      :default => true,
+      :description => "Verify config at config/initializers/cambium.rb"
+    )
+
+    # If there is no configuration file tell the user to run
+    # that generator first (unless user has manually
+    # overridden).
+    #
+    def verify_configuration
+      if options.config_check?
+        unless File.exists?("#{Rails.root}/config/initializers/cambium.rb")
+          help_message('cambium_prereqs')
+          exit
+        end
+      end
+    end
+
+    # Generate a migration so we can keep users from
+    # accessing the admin if they don't have permission
+    #
+    def add_admin_migration
+      generate "migration add_is_admin_to_users" # is_admin:boolean"
+      Dir.glob("#{Rails.root.join('db','migrate')}/*.rb").each do |file|
+        filename = file.split('/').last
+        if filename =~ /is\_admin/
+          insert_into_file(
+            "db/migrate/#{filename}",
+            "\n    add_column :users, :is_admin, :boolean, :default => false",
+            :after => "def change"
+          )
+        end
+      end
+    end
+
+    # Add another migration for user profile fields
+    #
+    def add_user_profile
+      generate "migration add_user_profile_fields_to_users name:string"
+    end
+
+    # Add admin sidebar file to the project
+    #
+    def add_admin_routes
+      ['sidebar','users'].each do |file|
+        template "config/admin/#{file}.yml", "config/admin/#{file}.yml"
+      end
+    end
+
+    # Add migration for paper_trail versions
+    #
+    def add_paper_trail
+      generate 'paper_trail:install'
+      Dir.glob("#{Rails.root}/app/models/*.rb").each do |f|
+        insert_into_file f.to_s, :after => "ActiveRecord::Base\n" do
+          "  # ------------------------------------------ Plugins\n" +
+          "  has_paper_trail\n"
+        end
+      end
+    end
+
+    # Add migration for pg_search
+    #
+    def add_pg_search
+      generate 'pg_search:migration:multisearch'
+      help_message('pg_search_post_install')
+    end
+
+    # Add pg_search to users
+    #
+    def add_user_search
+      insert_into_file(
+        "#{Rails.root}/app/models/user.rb", :after => "---- Plugins\n"
+      ) do
+        "  include PgSearch\n" +
+        "  multisearchable :against => [:name, :email]\n"
+      end
+    end
+
+    # Adds a manifest SCSS file to the project, so the
+    # developer can override any admin styles with creating
+    # a new layout
+    #
+    def add_css_override
+      file = "app/assets/stylesheets/admin/admin.scss"
+      template(file, file)
+    end
+
+  end
+end

data/lib/generators/cambium/app_generator.rb

@@ -0,0 +1,205 @@
+require 'rake'
+require 'rails/generators'
+require File.expand_path('../../helpers/_autoloader.rb', __FILE__)
+
+module Cambium
+  class AppGenerator < Rails::Generators::Base
+
+    desc "Add all the pieces to your application per your configuration."
+
+    source_root File.expand_path('../../templates', __FILE__)
+
+    class_option(
+      :config_check,
+      :type => :boolean,
+      :default => true,
+      :description => "Verify config at config/initializers/cambium.rb"
+    )
+
+    # If there is no configuration file tell the user to run
+    # that generator first (unless user has manually
+    # overridden).
+    #
+    def verify_configuration
+      if options.config_check?
+        unless File.exists?("#{Rails.root}/config/initializers/cambium.rb")
+          help_message('cambium_prereqs')
+          exit
+        end
+      end
+    end
+
+    # Wrap our config values up in an easier-to-type
+    # variable
+    #
+    def set_config
+      @config = Cambium.configuration
+    end
+
+    # Set root url for mailer in development and production
+    #
+    def set_url_config
+      environment(
+        "config.action_mailer.default_url_options = { :host => '#{@config.development_url}' }",
+        :env => "development"
+      )
+      environment(
+        "config.action_mailer.default_url_options = { :host => '#{@config.production_url}' }",
+        :env => "production"
+      )
+    end
+
+    # Add modernizr to our list of assets to precompile when
+    # we're ready to deploy
+    #
+    def set_precompiled_assets
+      environment(
+        "config.assets.precompile += %w( modernizr.js )",
+        :env => "production"
+      )
+    end
+
+    # Add settings to application config file
+    # (config/application.rb)
+    #
+    def add_application_config
+      environment { file_contents("config/application.rb") }
+    end
+
+    # Assets initializer for Rails 4.1+
+    #
+    def add_assets_initializer
+      file = "config/initializers/assets.rb"
+      template(file, file)
+    end
+
+    # Add custom gitignore file
+    #
+    def add_gitignore
+      remove_file ".gitignore"
+      template "gitignore", ".gitignore"
+    end
+
+    # Add a default public controller, so we have a working
+    # home page when we're done.
+    #
+    def add_home_controller
+      generate "controller home index"
+    end
+
+    # Add our default public views
+    #
+    def add_public_views
+      directory "app/views/application"
+      directory "app/views/home", :force => true
+    end
+
+    # Our layouts are templated so we can start with
+    # some custom information.
+    #
+    def add_layouts
+      app = "app/views/layouts/application.html.erb"
+      template app, app, :force => true
+    end
+
+    # We're going to automatically install backbone unless
+    # the user has disabled it
+    #
+    def add_js_framework
+      directory("app/assets/javascripts", "app/assets/javascripts")
+    end
+
+    # Next, we need to replace our application.js file to add
+    # backbone and its dependencies, along with our default
+    # scripts.
+    #
+    def add_js_manifest
+      app_js = "app/assets/javascripts/application.js"
+      remove_file app_js
+      app_js += ".coffee"
+      template app_js, app_js
+    end
+
+    # Add our application.scss file. Since we don't know what
+    # file exists, we look for and delete all and replace with
+    # ours.
+    #
+    def add_public_manifest
+      ['css','scss','scss.css'].each do |ext|
+        file = "app/assets/stylesheets/application.#{ext}"
+        remove_file(file) if File.exists?(file)
+      end
+      manifest_file = "app/assets/stylesheets/application.scss"
+      template manifest_file, manifest_file
+    end
+
+    # Go through standard Devise installation
+    #
+    def install_devise
+      generate "devise:install"
+    end
+
+    # Add a User model
+    #
+    def add_devise_user_model
+      generate "devise User"
+    end
+
+    # Copy our custom user model template into the app
+    #
+    def add_user_model_file
+      copy_file "app/models/user.rb", "app/models/user.rb", :force => true
+    end
+
+    # Override Devise's default redirects and sign in/out
+    #
+    def add_application_controller_redirects
+      insert_into_file(
+        "app/controllers/application_controller.rb",
+        template_snippet("app/controllers/application_controller.rb"),
+        :after => ":exception"
+      )
+    end
+
+    # Install Simple Form automatically
+    #
+    def install_simple_form
+      generate "simple_form:install"
+    end
+
+    # Add ruby class overrides and additions
+    #
+    def add_ruby_class_overrides
+      template "config/initializers/_hash.rb", "config/initializers/_hash.rb"
+    end
+
+    # Add our settings and private settings files
+    #
+    def add_settings_files
+      template "config/initializers/_settings.rb",
+        "config/initializers/_settings.rb"
+      ['settings','private'].each do |s|
+        template "config/#{s}.yml", "config/#{s}.yml"
+      end
+    end
+
+    # Add the custom seed generator, which loads content
+    # from CSV into the database.
+    #
+    def add_seed_generator
+      remove_file "db/seeds.rb"
+      template "db/seeds.rb", "db/seeds.rb"
+    end
+
+    # Add our default routes file, which is commented out
+    # except for the root path to the home controller.
+    #
+    # We don't override routes here in case the user started
+    # to edit their routes file before running this generator.
+    #
+    def add_default_routes
+      template "config/routes.rb", "config/routes.rb", :force => true
+    end
+
+  end
+end

data/lib/generators/cambium/controller_generator.rb

@@ -0,0 +1,81 @@
+require 'rake'
+require 'rails/generators'
+require File.expand_path('../../helpers/_autoloader.rb', __FILE__)
+
+module Cambium
+  class ControllerGenerator < Rails::Generators::Base
+
+    desc "Installs a controller to use in Cambium's CMS."
+
+    source_root File.expand_path('../../templates', __FILE__)
+
+    argument :model, :type => :string
+
+    # class_option(
+    #   :config_check,
+    #   :type => :boolean,
+    #   :default => true,
+    #   :description => "Verify config at config/initializers/cambium.rb"
+    # )
+
+    # If there is no configuration file tell the user to run
+    # that generator first (unless user has manually
+    # overridden).
+    #
+    # def verify_configuration
+    #   if options.config_check?
+    #     unless File.exists?("#{Rails.root}/config/initializers/cambium.rb")
+    #       help_message('cambium_prereqs')
+    #       exit
+    #     end
+    #   end
+    # end
+
+    def confirm_model
+      @model = model.constantize
+    rescue
+      puts "Can't find the model: #{model}"
+      exit
+    end
+
+    def set_model_attrs
+      @model_pl = @model.to_s.humanize.downcase.pluralize
+      @columns = @model.columns.reject { |col|
+        ['id','created_at','updated_at'].include?(col.name) }
+    end
+
+    def generate_controller
+      generate "controller admin/#{@model_pl}"
+      template(
+        "app/controllers/admin/controller.rb.erb",
+        "app/controllers/admin/#{@model_pl}_controller.rb",
+        :force => true
+      )
+    end
+
+    def add_routes
+      route  = "  namespace :admin do\n"
+      route += "    resources :#{@model_pl}\n"
+      route += "  end\n"
+      insert_into_file(
+        "config/routes.rb",
+        route,
+        :after => /mount\ Cambium\:(.*)\n/
+      )
+    end
+
+    def add_config_file
+      template "config/admin/controller.yml.erb", "config/admin/#{@model_pl}.yml"
+    end
+
+    def add_sidebar_item
+      config  = "#{@model_pl}:\n"
+      config += "  label: #{@model_pl.titleize}\n"
+      config += "  route: main_app.admin_#{@model_pl}\n"
+      config += "  icon: cog\n"
+      config += "  controllers: ['#{@model_pl}']\n"
+      append_to_file("config/admin/sidebar.yml", config)
+    end
+
+  end
+end

data/lib/generators/cambium/gemfile_generator.rb

@@ -0,0 +1,36 @@
+require 'rake'
+require 'rails/generators'
+
+module Cambium
+  class GemfileGenerator < Rails::Generators::Base
+
+    desc "Replace your existing Gemfile with Cambium's default Gemfile."
+
+    source_root File.expand_path('../../templates', __FILE__)
+
+    # Here we figure out some of the more complicated logic
+    # before rendering the Gemfile template
+    #
+    def resolve_options
+      @rails_version = `bundle exec rails -v`.to_s.split(' ').last
+    end
+
+    # Move our default Gemfile to the project's Gemfile.
+    #
+    def add_config_file
+      template "Gemfile.erb", "Gemfile", :force => true
+      gsub_file "Gemfile", /\n\n\n+?/, "\n\n"
+    end
+
+    private
+
+      def gem_root
+        Gem::Specification.find_by_name("cambium").gem_dir
+      end
+
+      def help_message(file)
+        puts File.read("#{gem_root}/lib/help/#{file}.txt")
+      end
+
+  end
+end

data/lib/generators/cambium/install_generator.rb

@@ -0,0 +1,19 @@
+require 'rake'
+require 'rails/generators'
+
+module Cambium
+  class InstallGenerator < Rails::Generators::Base
+    desc "Add Cambium config file to your initializers."
+
+    source_root File.expand_path('../../templates', __FILE__)
+
+    # Copy our Cambium config file into the project's
+    # config/initializers directory.
+    #
+    def add_config_file
+      config_file = "config/initializers/cambium.rb"
+      copy_file config_file, config_file
+    end
+
+  end
+end

data/lib/generators/cambium/user_generator.rb

@@ -0,0 +1,40 @@
+require 'rake'
+require 'rails/generators'
+
+module Cambium
+  class UserGenerator < Rails::Generators::Base
+
+    desc "Create a new user for your app."
+
+    source_root File.expand_path('../../templates', __FILE__)
+
+    class_option(
+      :admin,
+      :type => :boolean,
+      :default => false,
+      :description => "Make the user an admin"
+    )
+
+    argument :email, :type => :string
+    argument :password, :type => :string
+
+    # Create a user with the provided credentials
+    def create_user
+      if options.admin == true
+        User.create!(
+          :email => email,
+          :password => password,
+          :password_confirmation => password,
+          :is_admin => options.admin
+        )
+      else
+        User.create!(
+          :email => email,
+          :password => password,
+          :password_confirmation => password
+        )
+      end
+    end
+
+  end
+end

data/lib/generators/{cambium/helpers → helpers}/generators_helper.rb

@@ -4,13 +4,13 @@ module Cambium
     # ------------------------------------------ System Commands / Aliases
 
     # Shorthand for `bundle exec`
-    # 
+    #
     def be
       "bundle exec"
     end
 
     # Runs a system command, but with pretty output
-    # 
+    #
     def run_cmd(cmd, options = {})
       print_table(
         [
@@ -27,7 +27,7 @@ module Cambium
 
     # Make sure we get a matching answer before moving on. Useful for usernames,
     # passwords, and other items where user error is harmful (or painful)
-    # 
+    #
     def confirm_ask(question)
       answer = ask("\n#{question}")
       match = ask("CONFIRM #{question}")
@@ -40,13 +40,13 @@ module Cambium
     end
 
     # Run rake db:migrate
-    # 
+    #
     def migrate
       rake "db:migrate"
     end
 
     # Annotate our models and tests
-    # 
+    #
     def annotate
       # need to make sure we have the annotate gem to avoid errors
       install_gem('annotate')
@@ -54,7 +54,7 @@ module Cambium
     end
 
     # Run migrate and annotate
-    # 
+    #
     def migrate_and_annotate
       migrate
       annotate
@@ -63,7 +63,7 @@ module Cambium
     # ------------------------------------------ Templating
 
     # Copy template file to project unless it's already there
-    # 
+    #
     def copy_unless_exists(path, new_path = path)
       copy_file(path, new_path) unless File.exists?("#{Rails.root}/#{new_path}")
     end
@@ -73,20 +73,20 @@ module Cambium
     end
 
     # Get the path to a particular template
-    # 
+    #
     def template_file(name)
       File.expand_path("../../templates/#{name}", __FILE__)
     end
 
     # Partial template path are for templates that aren't the entire file to be
     # copied.
-    # 
+    #
     def template_partial_path(name)
       File.expand_path("../../templates/_partials/#{name}", __FILE__)
     end
 
     # Read a template and return its contents
-    # 
+    #
     def file_contents(template)
       File.read(template_file(template))
     end
@@ -97,25 +97,25 @@ module Cambium
     end
 
     # Copies model concern templates to the project
-    # 
+    #
     def add_model_concern(name)
       copy_unless_exists "app/models/concerns/#{name}.rb"
     end
 
     # Alias for previous method
-    # 
+    #
     def model_concern(name)
       add_model_concern(name)
     end
 
     # Add multiple concerns
-    # 
+    #
     def add_model_concerns(concerns)
       concerns.each { |c| add_model_concern(c) }
     end
 
     # Copy multiple directories
-    # 
+    #
     def directories(dir_arr, container)
       dir_arr.each do |dir|
         directory "#{container}/#{dir}", "#{container}/#{dir}"
@@ -125,14 +125,14 @@ module Cambium
     # ------------------------------------------ Gems
 
     # Run `bundle install`
-    # 
+    #
     def bundle
       run_cmd "bundle install"
       run_cmd "bundle clean"
     end
 
     # Get the local path where the gems are installed
-    # 
+    #
     def gem_dir
       gem_dir = `bundle show rails`
       gem_dir = gem_dir.split('/')
@@ -140,7 +140,7 @@ module Cambium
     end
 
     # Add gem to Gemfile
-    # 
+    #
     def add_to_gemfile(name, options = {})
       unless gem_exists?(name)
         if options[:require].present?
@@ -158,17 +158,17 @@ module Cambium
     end
 
     # Find if a gem exists
-    # 
+    #
     def gem_exists?(name)
       Gem::Specification::find_all_by_name(name).any?
     end
 
     # First, install the gem in the local gem directory, then add it to the
     # Gemfile (if it doesn't already exist).
-    # 
+    #
     # Note: This will run bundle install after adding the gem, unless specified
     # otherwise.
-    # 
+    #
     def install_gem(name, options = {})
       if gem_exists?(name)
         say "Found existing gem: #{name}"
@@ -181,7 +181,7 @@ module Cambium
 
     # Install an array of gems -- useful if needing to install more than one
     # gem.
-    # 
+    #
     def install_gems(gem_arr)
       gem_arr.each { |gem_name| install_gem(gem_name, :bundle => false) }
       bundle
@@ -189,7 +189,7 @@ module Cambium
 
     # Notifies the user of the gems that were installed and how desperately
     # important they are.
-    # 
+    #
     def gem_installation_notification(gems)
       say "\nThis generator installed the following gems (and added them to "
       say "your Gemfile):\n\n"
@@ -199,7 +199,7 @@ module Cambium
 
     # Similar to gem_installation_notification, except here we just tell the
     # user we added gems to the gemfile and they will have to bundle
-    # 
+    #
     def gemfile_update_notification(gems)
       say "\nThis generator added some gems to your Gemfile. You will want to "
       say "run:\n\n    $ bundle install"
@@ -210,7 +210,7 @@ module Cambium
     # ------------------------------------------ Miscellaneous
 
     # Return current time in migration timestamp format
-    # 
+    #
     def timestamp
       Time.now.gmtime.strftime('%Y%m%d%H%M%S')
     end
@@ -223,5 +223,13 @@ module Cambium
       klass.is_a?(Class)
     end
 
+    def gem_root
+      Gem::Specification.find_by_name("cambium").gem_dir
+    end
+
+    def help_message(file)
+      puts File.read("#{gem_root}/lib/help/#{file}.txt")
+    end
+
   end
 end