forge-cli 0.0.18 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e10ec0676cc31af13d158fae4cbfd36751bb7b6c
+  data.tar.gz: 2459df7caa0e5c5db327afaefa4c9d7c9b464ae2
+SHA512:
+  metadata.gz: c53dd6ce30134a189abd235fd26543cde5157ce99daf8e016c4f407041fae7b03df3bd17effac3f5480364370d915f7a87bf2c88afc3ba747500a255289c0d9e
+  data.tar.gz: 38fd8650401584d9f884d5144dad934450faf64ae45d95cc5d62fac30a1ef99715592b89bb102f63b7f4566a363c1f672ab25996bb0ffa6bb1843a37f7b661cf

data/README.md

@@ -0,0 +1,106 @@
+# forge-cli
+
+Command line interface for creating Forge apps, which are Rails-based applications that come with a host of features
+for content management, rapid application development, and improved scaffold generation.
+
+Although the end result of this gem is the creation of a Rails 4 application that you can certainly use as the basis
+for a new web application, this gem itself is still alpha quality and is undergoing heavy development.  You can, however,
+create production-ready applications with it (and we do all the time).  Documentation is also greatly lacking at this
+point.
+
+## Requirements
+
+Ruby 1.9.3 or higher.  Forge is best at creating Rails 4 applications using Ruby 2.0.
+
+## Installation
+
+    gem install forge-cli
+
+## Usage
+
+### Installation And Modules
+
+To create a new Forge site:
+
+    forge new APP_NAME LIST,OF,MODULES
+
+For example:
+
+    forge new app banners,dispatches,ecommerce,events,galleries,posts,subscribers,videos
+
+The gem will display next steps once you've created the application.
+
+Once the app is created, you can see a list of available modules by running:
+
+    forge list
+
+To install a module that is not yet installed, use:
+
+    forge install MODULE_NAME
+
+### Scaffold Generation
+
+Forge comes with an advanced scaffold generation system that makes it extremely simple to create new,
+content-managed entities in the administration panel.
+
+To use the scaffold generator, run:
+
+    rails generate forge:scaffold MODEL_NAME LIST_OF_ATTRIBUTES_IN_STANDARD_RAILS_FORMAT
+
+For example:
+
+    rails generate forge:scaffold vehicle title:string description:text image_file_name:string image_file_size:integer image_content_type:string list_order:integer publish_on:timestamp
+
+As well as generating standard text fields as per Rails' normal behaviour, the scaffolder understands the following:
+
+* `ATTRIBUTE_NAME:timestamp` (generates a calendar picker with a time field)
+* `title:string` (generates a large text field at the top of the form for the title)
+* `ATTRIBUTE_file_name:string, ATTRIBUTE_file_size:integer, ATTRIBUTE_content_type:string` (generates Paperclip-styled attachments that hook into the Asset Library)
+* `list_order:integer` (makes the list of items in Forge reorderable using drag & drop)
+
+You can also generate scaffolds for "small" entities, such as post categories, that have a streamlined interface as follows:
+
+
+
+## Available Modules
+
+* banners (e.g. for image carousels on a homepage)
+* subscribers (subscribe management)
+* dispatches (full-fledged newsletter sending system, installs subscribers as well)
+* ecommerce (the lack of documentation for this module makes it rather hard to use right now)
+* events (including a calendar if you wish)
+* galleries (for photos)
+* posts (i.e. blogging)
+* videos
+
+## Contributing
+
+Contributions are welcome.  Right now the process of contributing is as follows:
+
+1. Fork the gem
+2. Use the local copy of the gem to create a new site, e.g: `bin/forge new testapp banners,dispatches`
+3. Spin up the new app
+4. Work on the new app as you would work on a normal Rails site
+5. Copy the changed/new files from the new app into the gem's lib/forge folder.  For example, if you changed
+   `app/controllers/application_controller.rb` in your new app, you would copy that into the gem's `lib/forge/app/controllers` folder.
+6. Commit your changes and issue a pull request.
+
+
+## LICENSE
+
+(The MIT License)
+
+Copyright (c) 2013 factor[e] design initiative
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the 'Software'), to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
+to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of
+the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
+THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/bin/cucumber

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'cucumber' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('cucumber', 'cucumber')

data/bin/erubis

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'erubis' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('erubis', 'erubis')

data/bin/htmldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'htmldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('diff-lcs', 'htmldiff')

data/bin/ldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'ldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('diff-lcs', 'ldiff')

data/bin/rackup

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rackup' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rack', 'rackup')

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/rdoc

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rdoc' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rdoc', 'rdoc')

data/bin/ri

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'ri' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rdoc', 'ri')

data/bin/sprockets

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'sprockets' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('sprockets', 'sprockets')

data/bin/thor

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'thor' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('thor', 'thor')

data/bin/tilt

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'tilt' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('tilt', 'tilt')

data/bin/tt

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'tt' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('treetop', 'tt')

data/lib/forge-cli.rb

@@ -16,6 +16,7 @@ require 'forge-cli/app.rb'
 # This is alphabetical
 require 'forge-cli/ability_installer.rb'
 require 'forge-cli/application_creator.rb'
+require 'forge-cli/controller_module_includer.rb'
 require 'forge-cli/custom_file_copier.rb'
 require 'forge-cli/forge_addon_requirer.rb'
 require 'forge-cli/module_installer.rb'

data/lib/forge-cli/application_creator.rb

@@ -32,16 +32,26 @@ class ForgeCLI::ApplicationCreator
     # Rewrite Forge3::Application
     rewrite_app_name
 
+    # create some new tokens
+    generate_devise_tokens
+
     STDOUT.puts completed_message
   end
 
   def completed_message
     %{
 #{"Your new Forge site is almost ready!  Next steps:".foreground(:cyan)}
-  1. Run 'bundle install'
-  2. Set up config/database.yml
-  3. Run 'rake db:migrate'
-  4. Run 'rake forge:create_admin
+  1.  Run 'bundle install'
+  2.  Set up config/database.yml
+  3.  Run 'rake db:create' unless your database already exists
+  4.  Run 'rake db:migrate'
+  5.  Run 'rake forge:create_admin'
+  6.  Run 'rake forge:load_help'
+  7.  Edit the contents of config/sitemap.yml, then run 'rake db:seed'
+  8.  Set up delayed job with 'rails generate delayed_job:active_record'
+  9.  Review the settings in config/initializers/devise.rb and config/settings.yml
+  10.  Run 'rails server' to spin up the application
+  11. Access Forge by going to /forge in your browser (e.g. http://localhost:3000/forge)
     }
   end
 
@@ -60,11 +70,20 @@ class ForgeCLI::ApplicationCreator
       ]
       files.each do |file|
         old_content = File.read(File.join(@app, file))
-        app_name = File.basename(@app).classify
+        app_name = File.basename(@app).gsub(/\W+/, '_').camelize
         new_content = old_content.gsub('Forge3', app_name)
         File.open(File.join(@app, file), 'w') do |f|
           f.puts new_content
         end
       end
     end
-end
+
+    def generate_devise_tokens
+      file = '/config/initializers/devise.rb'
+      old_content = File.read(File.join(@app, file))
+      new_content = old_content.gsub('DEVISE_SECRET_KEY', SecureRandom.hex(64)).gsub('DEVISE_PEPPER', SecureRandom.hex(64))
+      File.open(File.join(@app, file), 'w') do |f|
+        f.puts new_content
+      end
+    end
+end

data/lib/forge-cli/controller_module_includer.rb

@@ -0,0 +1,43 @@
+class ForgeCLI::ControllerModuleIncluder
+  attr_reader :module_name
+
+  def initialize(app, module_name)
+    @app = app
+    @module_name = module_name
+  end
+
+  def run!
+    add_initializer_content
+    add_controller_content
+  end
+
+  private
+    def add_controller_content
+      content = app_controller_content.gsub(
+          'class ApplicationController < ActionController::Base',
+          "class ApplicationController < ActionController::Base\n  include Forge::Controllers::#{module_name.camelize}\n"
+      )
+      File.open(app_controller_path, 'w') { |f| f.puts content }
+    end
+
+    def add_initializer_content
+      content = "require 'forge/shared_controller_methods/#{module_name.downcase.underscore.gsub(/\s/, '_')}.rb'\n" + forge_initializer_content
+      File.open(forge_initializer_path, 'w') { |f| f.puts content }
+    end
+
+    def app_controller_path
+      File.join(@app, 'app', 'controllers', 'application_controller.rb')
+    end
+
+    def app_controller_content
+      @app_controller_content ||= File.read(app_controller_path)
+    end
+
+    def forge_initializer_path
+      File.join(@app, 'config', 'initializers', 'forge.rb')
+    end
+
+    def forge_initializer_content
+      @forge_initializer_content ||= File.read(forge_initializer_path)
+    end
+end

data/lib/forge-cli/module_installer.rb

@@ -84,20 +84,25 @@ class ForgeCLI
         end
         files = Dir[File.join(source_path, '*.rb')]
         @mod["migrations"].each do |migration|
-          # Get the old migration
-          source_file = files.find {|f| f.match(%r{\d+_#{migration}.rb})}
-          content = File.open(source_file, 'r').read
+          # skip the migration if one already exists in the target path, e.g. if one was created
+          # as a result of a dependency already
+          target_files = Dir[File.join(destination_path, '*.rb')]
+          unless target_files.find {|f| f.match(%r{\d+_#{migration}.rb})}
+            # Get the old migration
+            source_file = files.find {|f| f.match(%r{\d+_#{migration}.rb})}
+            content = File.open(source_file, 'r').read
 
-          # Write the new one
-          timestamp = Time.now.strftime('%Y%m%d%H%M%S')
-          new_file_path = File.join(destination_path, "#{timestamp}_#{migration}.rb")
-          new_file = File.open(new_file_path, "w")
-          new_file.puts content
-          new_file.close
-          ForgeCLI::Output.write('migration', new_file_path.gsub("#{destination_path}/", ''))
+            # Write the new one
+            timestamp = Time.now.strftime('%Y%m%d%H%M%S')
+            new_file_path = File.join(destination_path, "#{timestamp}_#{migration}.rb")
+            new_file = File.open(new_file_path, "w")
+            new_file.puts content
+            new_file.close
+            ForgeCLI::Output.write('migration', new_file_path.gsub("#{destination_path}/", ''))
 
-          # So that they have different timestamps
-          sleep 1
+            # So that they have different timestamps
+            sleep 1
+          end
         end
       end
 
@@ -117,4 +122,4 @@ class ForgeCLI
         end
       end
   end
-end
+end