cambium 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f60d6aff0476c3c97b3267f814543c225fd7ca9
-  data.tar.gz: 18f3fd992da17518053511cf2c5c926a217a3b5a
+  metadata.gz: 6881a831904e091c4228d69c086ba4a5622c60be
+  data.tar.gz: a35bac2b1517e59608167978861ca1a92cb1b94c
 SHA512:
-  metadata.gz: 9e4269547de6fc09cf705426b9395c0ef956a8ca224a903a7f1784e5d1b073f9ac4b16fda78a2bbd4fbc0d1886cb026b1e282e05b9c6c8189ee55bd2db3678bf
-  data.tar.gz: c659f23c1fc62a72b538c9ec0dc13982f8a53adbb0b551c93ca1a10fd0b12c934b44776d442db839ad7543d9c0ddeef69ecd093b64c8c433d4b80a1d1299a313
+  metadata.gz: 0fcfddb768d58f562c4243f7b3506d08b37e2e5bb3968c04db8b3ea9a7a6d42b66ad263e53b327aeb8d1443e9ac62cb4782c2c5f4930d5a601f059841c9cb7d0
+  data.tar.gz: 2ec1f058a8301385f794bb1ae7c623e93ae5eec0d874fbda981c030b27f6b872ff8134cda3ecce8452c52ac72bb108b26bd7d95ee5a2739286394ffd84ca528e

data/cambium.gemspec

@@ -6,8 +6,8 @@ require 'cambium/version'
 Gem::Specification.new do |spec|
   spec.name          = "cambium"
   spec.version       = Cambium::VERSION
-  spec.authors       = ["Sean C Davis"]
-  spec.email         = ["scdavis41@gmail.com"]
+  spec.authors       = ["Sean C Davis","Warren Harrison"]
+  spec.email         = ["scdavis41@gmail.com","warren@hungry-media.com"]
   spec.summary       = %q{Rails generators to facilitate development.}
   spec.description   = %q{}
   spec.homepage      = ""
@@ -21,26 +21,28 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_dependency "rake"
   spec.add_dependency "rails"
-  
-  [
-    'annotate', 
-    'backbone-on-rails',
-    'bones-rails', 
-    'bourbon', 
-    'carrierwave', 
-    'coffee-rails', 
-    'devise', 
-    'factory_girl_rails', 
-    'faker', 
-    'hirb',
-    'jbuilder', 
-    'jquery-rails', 
-    'pickadate-rails',
-    'sass-rails', 
-    'simple_form', 
-    'uglifier', 
-    'unicorn-rails', 
-    'wysihtml5-rails',
-  ].each { |g| spec.add_dependency g }
+
+  # [
+  #   'ancestry', 
+  #   'annotate',                     all models
+  #   'backbone-on-rails',            install:app
+  #   'bones-rails', 
+  #   'bourbon',                      install:app
+  #   'coffee-rails',                 install:app
+  #   'devise',                       model:user
+  #   'factory_girl_rails',           
+  #   'faker',                        
+  #   'hirb',                         
+  #   'jbuilder', 
+  #   'jquery-rails',                 install:app
+  #   'jquery-fileupload-rails',
+  #   'kaminari',
+  #   'pickadate-rails',
+  #   'sass-rails',                   install:app
+  #   'simple_form',                  
+  #   'uglifier',                     install:app
+  #   'unicorn-rails',                install:app
+  #   'wysihtml5-rails',
+  # ].each { |g| spec.add_dependency g }
 
 end

data/lib/cambium/version.rb

@@ -1,3 +1,3 @@
 module Cambium
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

data/lib/generators/cambium/helpers/_autoloader.rb

@@ -0,0 +1,12 @@
+Dir.glob(File.expand_path('../../helpers/**/*.rb', __FILE__)).each do |file|
+  unless file == __FILE__
+    require file
+    module_name = []
+    File.read(file).each_line do |line|
+      if line =~ /module\ /
+        module_name << line.gsub(/module\ /, '').strip
+      end
+    end
+    include module_name.join('::').constantize
+  end
+end

data/lib/generators/cambium/helpers/dependencies_helper.rb

@@ -0,0 +1,58 @@
+module Cambium
+  module DependenciesHelper
+
+    # This method accepts an array of dependencies as THE GENERATOR COMMAND. So,
+    # for example, if we need to make sure `bundle exec rails generate
+    # cambium:install:users` has been run, we would call
+    # check_dependencies(['cambium:install:users']).
+    # 
+    # We use that value to determine the subsequent method to call. So,
+    # check_dependencies(['cambium:install:users']) will call
+    # require_cambium_install_users
+    # 
+    def check_dependencies(dependencies = [])
+      cmds = []
+      dependencies.each do |d|
+        cmds << d unless eval("#{d.split(':').join('_')}_generated?")
+      end
+      if cmds.size > 0
+        display_dependency_errors(cmds)
+        exit
+      end
+    end
+
+    # Gives the user output of the errors
+    # 
+    def display_dependency_errors(cmds)
+      say set_color(
+        "\nERROR! You need to run the following command(s):\n",
+        :red, 
+        :bold
+      )
+      cmds.each { |cmd| say "    $ bundle exec rails g #{cmd}" }
+      say set_color(
+        "\nbefore running this generator.",
+        :red,
+        :bold
+      )
+    end
+
+    ##########################################################################
+    # The following methods are the individual checks and their appropriate
+    # responses.                                          
+    ##########################################################################
+
+    def cambium_install_admin_generated?
+      class_exists?('AdminController')
+    end
+
+    def cambium_model_user_generated?
+      class_exists?('User')
+    end
+
+    def cambium_model_image_generated?
+      class_exists?('Image')
+    end
+
+  end
+end

data/lib/generators/cambium/helpers/generators_helper.rb

@@ -0,0 +1,227 @@
+module Cambium
+  module GeneratorsHelper
+
+    # ------------------------------------------ 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(
+        [
+          [set_color("run", :green, :bold), cmd]
+        ],
+        :indent => 9
+      )
+      if options[:quiet] == true
+        `#{cmd}`
+      else
+        system(cmd)
+      end
+    end
+
+    # 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}")
+      if answer == match
+        answer
+      else
+        say set_color("Did not match.", :red)
+        confirm_ask(question)
+      end
+    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')
+      run_cmd "#{be} annotate"
+    end
+
+    # Run migrate and annotate
+    # 
+    def migrate_and_annotate
+      migrate
+      annotate
+    end
+
+    # ------------------------------------------ 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
+
+    def copy_files(files, dir)
+      files.each { |f| copy_unless_exists("#{dir}/#{f}") }
+    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
+
+    def template_snippet(template)
+      require 'erb'
+      ERB.new(File.read(template_file(template))).result(binding)
+    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}"
+      end
+    end
+
+    # ------------------------------------------ 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('/')
+      gem_dir[0..-3].join('/')
+    end
+
+    # Add gem to Gemfile
+    # 
+    def add_to_gemfile(name, options = {})
+      unless gem_exists?(name)
+        if options[:require].present?
+          text = "\n\ngem '#{name}', :require => '#{options[:require]}'"
+        else
+          text = "\n\ngem '#{name}'"
+        end
+        insert_into_file "Gemfile", text, :after => "rubygems.org'"
+      end
+    end
+
+    # Add several gems to the gemfile
+    def add_gems_to_gemfile(gems)
+      gems.each { |g| add_to_gemfile(g) }
+    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}"
+      else
+        run "gem install #{name} -i #{gem_dir}"
+        add_to_gemfile(name, options)
+        bundle if options[:bundle].nil? || options[:bundle] == true
+      end
+    end
+
+    # 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
+    end
+
+    # 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"
+      gems.each { |g| say "    #{g}" }
+      say "\nThese gems *may* be necessary for Cambium to work properly. "
+    end
+
+    # 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"
+      say "\nto complete this generator. Please note, "
+      say "these gems *may* be necessary for Cambium to work properly."
+    end
+
+    # ------------------------------------------ Miscellaneous
+
+    # Return current time in migration timestamp format
+    # 
+    def timestamp
+      Time.now.gmtime.strftime('%Y%m%d%H%M%S')
+    end
+
+    # Check to see if a class exists. This can be helpful in determining if
+    # other generators have been run.
+    #
+    def class_exists?(class_name)
+      klass = Module.const_get(class_name)
+      klass.is_a?(Class)
+    end
+
+  end
+end

data/lib/generators/cambium/install/admin_generator.rb

@@ -1,115 +1,109 @@
 require 'rake'
 require 'rails/generators'
+require File.expand_path('../../helpers/_autoloader.rb', __FILE__)
 
 module Cambium
   module Install
     class AdminGenerator < Rails::Generators::Base
       desc "Setup admin files for new rails project"
 
-      # ------------------------------------------ Class Methods
-
       source_root File.expand_path('../../templates', __FILE__)
-
-      # ------------------------------------------ Admin Controller
-
-      def add_admin_controller
-        template "app/controllers/admin_controller.rb", 
-          "app/controllers/admin_controller.rb"
+ 
+      def set_dependencies
+        check_dependencies(['cambium:model:user'])
       end
 
-      # ------------------------------------------ Admin Users Controller
-
-      def add_admin_users_controller
-        template "app/controllers/admin/users_controller.rb", 
-          "app/controllers/admin/users_controller.rb"
+      # Admin controllers are added in this manner because we have controllers
+      # in the directory which we do not want to copy over by default.
+      # 
+      def add_admin_controller
+        copy_files [
+          'admin_controller.rb',
+          'admin/users_controller.rb'
+        ], "app/controllers"
       end
 
-      # ------------------------------------------ Admin Views
-
+      # Continuing from the previous method, we also need to individually copy
+      # the view files over, since these default views have to site directly in
+      # the app/views/admin folder, and can't be placed in a subdirectory.
+      # 
+      # Any new partial will have to be added here manually.
+      # 
       def add_admin_views
-        directory "app/views/admin", "app/views/admin"
+        copy_files [
+          '_buttons.html.erb',
+          '_form.html.erb',
+          '_title.html.erb',
+          'edit.html.erb',
+          'index.html.erb',
+          'new.html.erb'
+        ], "app/views/admin"
+        directories ['shared','users'], "app/views/admin"
       end
 
-      # ------------------------------------------ Layouts
-
+      # The admin layout gives us the customization we need to layout our CMS.
+      # Here we ask the user for some input for those items that will vary from
+      # project-to-project.
+      # 
       def add_layouts
         @site_title = "#{Rails.application.class.parent_name.humanize.titleize} Admin"
         site_title = ask "\n#{set_color('Admin Title:', :green, :bold)} [default: #{@site_title}]"
         @site_title = site_title unless site_title.blank?
-
         admin = "app/views/layouts/admin.html.erb"
         template admin, admin
       end
 
-      # ------------------------------------------ Admin Helper
-
+      # Currently, all the helper methods are shoved into one file. The plan is
+      # to break the methods out into individual helpers, namespaced under
+      # admin.
+      # 
       def add_admin_helper
         template "app/helpers/admin_helper.rb", 
           "app/helpers/admin_helper.rb"
       end
 
-      # ------------------------------------------ Admin Setup
-
-      def add_admin_files
+      # Like the app side, the admin uses the Backbone.js framework since it's
+      # lightweight and easy-to-use. We've added several scripts to make your
+      # CMS powerful right out of the box.
+      # 
+      def add_admin_javascripts
         directory "app/assets/javascripts/admin",
           "app/assets/javascripts/admin"
       end
 
-      # ------------------------------------------ Admin Styles
-
+      # Our admin styles use Bones, along with some customization on top of
+      # Bones. Let's install these.
+      # 
       def add_admin_styles
         directory "app/assets/stylesheets/admin",
           "app/assets/stylesheets/admin"
       end
 
-      # ------------------------------------------ Private Methods
-
-      private
-
-        def run_cmd(cmd, options = {})
-          print_table(
-            [
-              [set_color("run", :green, :bold), cmd]
-            ],
-            :indent => 9
-          )
-          if options[:quiet] == true
-            `#{cmd}`
-          else
-            system(cmd)
-          end
-        end
-
-        def template_file(name)
-          File.expand_path("../../templates/#{name}", __FILE__)
-        end
-
-        def file_contents(template)
-          File.read(template_file(template))
-        end
-
-        def be
-          "bundle exec"
-        end
-
-        def g
-          "#{be} rails g"
-        end
-
-        def rake
-          "#{be} rake"
-        end
-
-        def confirm_ask(question)
-          answer = ask("\n#{question}")
-          match = ask("CONFIRM #{question}")
-          if answer == match
-            answer
-          else
-            say set_color("Did not match.", :red)
-            confirm_ask(question)
-          end
-        end
+      # Here we are adding the gems we will need for the admin. Many of these
+      # are duplicates from the app gems, but that's ok, since we check to see
+      # if they exist first.
+      # 
+      def add_application_gems
+        gems = [
+          'unicorn-rails',
+          'jquery-rails',
+          'uglifier',
+          'sass-rails',
+          'bourbon',
+          'coffee-rails',
+          'backbone-on-rails',
+          'bones-rails',
+          'jbuilder',
+          'pickadate-rails',
+          'simple_form',
+          'wysihtml5-rails',
+          'jquery-fileupload-rails',
+        ]
+        add_gems_to_gemfile(gems)
+        added_gems = []
+        gems.each { |g| added_gems << g unless gem_exists?(g) }
+        gemfile_update_notification(added_gems)
+      end
 
     end
   end