lightrail 0.0.1 → 0.99.0

data/lib/lightrail/generators/app_base.rb

@@ -0,0 +1,281 @@
+require 'digest/md5'
+require 'securerandom'
+require 'active_support/core_ext/string/strip'
+require 'lightrail/version'
+require 'rbconfig'
+require 'open-uri'
+require 'uri'
+
+module Lightrail
+  module Generators
+    class AppBase < Base
+      DATABASES = %w( mysql oracle postgresql sqlite3 frontbase ibm_db sqlserver )
+      JDBC_DATABASES = %w( jdbcmysql jdbcsqlite3 jdbcpostgresql jdbc )
+      DATABASES.concat(JDBC_DATABASES)
+
+      attr_accessor :rails_template
+      add_shebang_option!
+
+      argument :app_path,               :type => :string
+
+      def self.add_shared_options_for(name)
+        class_option :builder,            :type => :string, :aliases => "-b",
+                                          :desc => "Path to a #{name} builder (can be a filesystem path or URL)"
+
+        class_option :template,           :type => :string, :aliases => "-m",
+                                          :desc => "Path to an #{name} template (can be a filesystem path or URL)"
+
+        class_option :skip_gemfile,       :type => :boolean, :default => false,
+                                          :desc => "Don't create a Gemfile"
+
+        class_option :skip_bundle,        :type => :boolean, :default => false,
+                                          :desc => "Don't run bundle install"
+
+        class_option :skip_git,           :type => :boolean, :aliases => "-G", :default => false,
+                                          :desc => "Skip Git ignores and keeps"
+
+        class_option :skip_active_record, :type => :boolean, :aliases => "-O", :default => false,
+                                          :desc => "Skip Active Record files"
+
+        class_option :skip_sprockets,     :type => :boolean, :aliases => "-S", :default => false,
+                                          :desc => "Skip Sprockets files"
+
+        class_option :database,           :type => :string, :aliases => "-d", :default => "sqlite3",
+                                          :desc => "Preconfigure for selected database (options: #{DATABASES.join('/')})"
+
+        class_option :javascript,         :type => :string, :aliases => '-j', :default => 'jquery',
+                                          :desc => 'Preconfigure for selected JavaScript library'
+
+        class_option :skip_javascript,    :type => :boolean, :aliases => "-J", :default => false,
+                                          :desc => "Skip JavaScript files"
+
+        class_option :dev,                :type => :boolean, :default => false,
+                                          :desc => "Setup the #{name} with Gemfile pointing to your Rails checkout"
+
+        class_option :edge,               :type => :boolean, :default => false,
+                                          :desc => "Setup the #{name} with Gemfile pointing to Rails repository"
+
+        class_option :skip_test_unit,     :type => :boolean, :aliases => "-T", :default => false,
+                                          :desc => "Skip Test::Unit files"
+
+        class_option :help,               :type => :boolean, :aliases => "-h", :group => :rails,
+                                          :desc => "Show this help message and quit"
+
+        class_option :old_style_hash,     :type => :boolean, :default => false,
+                                          :desc => "Force using old style hash (:foo => 'bar') on Ruby >= 1.9"
+      end
+
+      def initialize(*args)
+        @original_wd = Dir.pwd
+        super
+        convert_database_option_for_jruby
+      end
+
+    protected
+
+      def builder
+        @builder ||= begin
+          if path = options[:builder]
+            if URI(path).is_a?(URI::HTTP)
+              contents = open(path, "Accept" => "application/x-thor-template") {|io| io.read }
+            else
+              contents = open(File.expand_path(path, @original_wd)) {|io| io.read }
+            end
+
+            prok = eval("proc { #{contents} }", TOPLEVEL_BINDING, path, 1)
+            instance_eval(&prok)
+          end
+
+          builder_class = get_builder_class
+          builder_class.send(:include, ActionMethods)
+          builder_class.new(self)
+        end
+      end
+
+      def build(meth, *args)
+        builder.send(meth, *args) if builder.respond_to?(meth)
+      end
+
+      def create_root
+        self.destination_root = File.expand_path(app_path, destination_root)
+        valid_const?
+
+        empty_directory '.'
+        set_default_accessors!
+        FileUtils.cd(destination_root) unless options[:pretend]
+      end
+
+      def apply_rails_template
+        apply rails_template if rails_template
+      rescue Thor::Error, LoadError, Errno::ENOENT => e
+        raise Error, "The template [#{rails_template}] could not be loaded. Error: #{e}"
+      end
+
+      def set_default_accessors!
+        self.rails_template = case options[:template]
+          when /^https?:\/\//
+            options[:template]
+          when String
+            File.expand_path(options[:template], Dir.pwd)
+          else
+            options[:template]
+        end
+      end
+
+      def database_gemfile_entry
+        options[:skip_active_record] ? "" : "gem '#{gem_for_database}'\n"
+      end
+
+      def include_all_railties?
+        !options[:skip_active_record] && !options[:skip_test_unit] && !options[:skip_sprockets]
+      end
+
+      def comment_if(value)
+        options[value] ? '# ' : ''
+      end
+
+      def rails_gemfile_entry
+        if options.dev?
+          <<-GEMFILE.strip_heredoc
+            gem 'rails',     :path => '#{Rails::Generators::RAILS_DEV_PATH}'
+            gem 'journey',   :git => 'git://github.com/rails/journey.git'
+            gem 'arel',      :git => 'git://github.com/rails/arel.git'
+          GEMFILE
+        elsif options.edge?
+          <<-GEMFILE.strip_heredoc
+            gem 'rails',     :git => 'git://github.com/rails/rails.git', :branch => '3-2-stable'
+            gem 'journey',   :git => 'git://github.com/rails/journey.git'
+            gem 'arel',      :git => 'git://github.com/rails/arel.git'
+          GEMFILE
+        else
+          <<-GEMFILE.strip_heredoc
+            gem 'rails', '#{Rails::VERSION::STRING}'
+
+            # Bundle edge Rails instead:
+            # gem 'rails', :git => 'git://github.com/rails/rails.git'
+          GEMFILE
+        end
+      end
+
+      def gem_for_database
+        # %w( mysql oracle postgresql sqlite3 frontbase ibm_db sqlserver jdbcmysql jdbcsqlite3 jdbcpostgresql )
+        case options[:database]
+        when "oracle"         then "ruby-oci8"
+        when "postgresql"     then "pg"
+        when "frontbase"      then "ruby-frontbase"
+        when "mysql"          then "mysql2"
+        when "sqlserver"      then "activerecord-sqlserver-adapter"
+        when "jdbcmysql"      then "activerecord-jdbcmysql-adapter"
+        when "jdbcsqlite3"    then "activerecord-jdbcsqlite3-adapter"
+        when "jdbcpostgresql" then "activerecord-jdbcpostgresql-adapter"
+        when "jdbc"           then "activerecord-jdbc-adapter"
+        else options[:database]
+        end
+      end
+
+      def convert_database_option_for_jruby
+        if defined?(JRUBY_VERSION)
+          case options[:database]
+          when "oracle"     then options[:database].replace "jdbc"
+          when "postgresql" then options[:database].replace "jdbcpostgresql"
+          when "mysql"      then options[:database].replace "jdbcmysql"
+          when "sqlite3"    then options[:database].replace "jdbcsqlite3"
+          end
+        end
+      end
+
+      def ruby_debugger_gemfile_entry
+        if RUBY_VERSION < "1.9"
+          "gem 'ruby-debug'"
+        else
+          "gem 'ruby-debug19', :require => 'ruby-debug'"
+        end
+      end
+
+      def assets_gemfile_entry
+        return if options[:skip_sprockets]
+
+        gemfile = if options.dev? || options.edge?
+          <<-GEMFILE
+            # Gems used only for assets and not required
+            # in production environments by default.
+            group :assets do
+              gem 'sass-rails',   :git => 'git://github.com/rails/sass-rails.git', :branch => '3-2-stable'
+              gem 'coffee-rails', :git => 'git://github.com/rails/coffee-rails.git', :branch => '3-2-stable'
+
+              # See https://github.com/sstephenson/execjs#readme for more supported runtimes
+              #{javascript_runtime_gemfile_entry}
+              gem 'uglifier', '>= 1.0.3'
+            end
+          GEMFILE
+        else
+          <<-GEMFILE
+            # Gems used only for assets and not required
+            # in production environments by default.
+            group :assets do
+              gem 'sass-rails',   '~> 3.2.3'
+              gem 'coffee-rails', '~> 3.2.1'
+
+              # See https://github.com/sstephenson/execjs#readme for more supported runtimes
+              #{javascript_runtime_gemfile_entry}
+              gem 'uglifier', '>= 1.0.3'
+            end
+          GEMFILE
+        end
+
+        gemfile.strip_heredoc.gsub(/^[ \t]*$/, '')
+      end
+
+      def javascript_gemfile_entry
+        "gem '#{options[:javascript]}-rails'" unless options[:skip_javascript]
+      end
+
+      def javascript_runtime_gemfile_entry
+        if defined?(JRUBY_VERSION)
+          "gem 'therubyrhino'\n"
+        else
+          "# gem 'therubyracer'\n"
+        end
+      end
+
+      def bundle_command(command)
+        say_status :run, "bundle #{command}"
+
+        # We are going to shell out rather than invoking Bundler::CLI.new(command)
+        # because `rails new` loads the Thor gem and on the other hand bundler uses
+        # its own vendored Thor, which could be a different version. Running both
+        # things in the same process is a recipe for a night with paracetamol.
+        #
+        # We use backticks and #print here instead of vanilla #system because it
+        # is easier to silence stdout in the existing test suite this way. The
+        # end-user gets the bundler commands called anyway, so no big deal.
+        #
+        # Thanks to James Tucker for the Gem tricks involved in this call.
+        print `"#{Gem.ruby}" -rubygems "#{Gem.bin_path('bundler', 'bundle')}" #{command}`
+      end
+
+      def run_bundle
+        bundle_command('install') unless options[:skip_gemfile] || options[:skip_bundle]
+      end
+
+      def empty_directory_with_gitkeep(destination, config = {})
+        empty_directory(destination, config)
+        git_keep(destination)
+      end
+
+      def git_keep(destination)
+        create_file("#{destination}/.gitkeep") unless options[:skip_git]
+      end
+
+      # Returns Ruby 1.9 style key-value pair if current code is running on
+      # Ruby 1.9.x. Returns the old-style (with hash rocket) otherwise.
+      def key_value(key, value)
+        if options[:old_style_hash] || RUBY_VERSION < '1.9'
+          ":#{key} => #{value}"
+        else
+          "#{key}: #{value}"
+        end
+      end
+    end
+  end
+end

data/lib/lightrail/generators/app_generator.rb

@@ -0,0 +1,299 @@
+require 'lightrail/generators/app_base'
+
+module Lightrail
+  module ActionMethods
+    attr_reader :options
+
+    def initialize(generator)
+      @generator = generator
+      @options   = generator.options
+    end
+
+    private
+      %w(template copy_file directory empty_directory inside
+         empty_directory_with_gitkeep create_file chmod shebang).each do |method|
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def #{method}(*args, &block)
+            @generator.send(:#{method}, *args, &block)
+          end
+        RUBY
+      end
+
+      # TODO: Remove once this is fully in place
+      def method_missing(meth, *args, &block)
+        @generator.send(meth, *args, &block)
+      end
+  end
+
+  # The application builder allows you to override elements of the application
+  # generator without being forced to reverse the operations of the default
+  # generator.
+  #
+  # This allows you to override entire operations, like the creation of the
+  # Gemfile, README, or JavaScript files, without needing to know exactly
+  # what those operations do so you can create another template action.
+  class AppBuilder
+    def rakefile
+      template "Rakefile"
+    end
+
+    def readme
+      copy_file "README", "README.rdoc"
+    end
+
+    def gemfile
+      template "Gemfile"
+    end
+
+    def configru
+      template "config.ru"
+    end
+
+    def gitignore
+      copy_file "gitignore", ".gitignore"
+    end
+
+    def app
+      directory 'app'
+      git_keep  'app/mailers'
+      git_keep  'app/models'
+    end
+
+    def config
+      empty_directory "config"
+
+      inside "config" do
+        template "routes.rb"
+        template "application.rb"
+        template "environment.rb"
+
+        directory "environments"
+        directory "initializers"
+        directory "locales"
+      end
+    end
+
+    def database_yml
+      template "config/databases/#{options[:database]}.yml", "config/database.yml"
+    end
+
+    def db
+      directory "db"
+    end
+
+    def doc
+      directory "doc"
+    end
+
+    def lib
+      empty_directory "lib"
+      empty_directory_with_gitkeep "lib/tasks"
+      empty_directory_with_gitkeep "lib/assets"
+    end
+
+    def log
+      empty_directory_with_gitkeep "log"
+    end
+
+    def public_directory
+      directory "public", "public", :recursive => false
+    end
+
+    def script
+      directory "script" do |content|
+        "#{shebang}\n" + content
+      end
+      chmod "script", 0755, :verbose => false
+    end
+
+    def test
+      empty_directory_with_gitkeep "test/fixtures"
+      empty_directory_with_gitkeep "test/functional"
+      empty_directory_with_gitkeep "test/integration"
+      empty_directory_with_gitkeep "test/unit"
+
+      template "test/performance/browsing_test.rb"
+      template "test/test_helper.rb"
+    end
+
+    def tmp
+      empty_directory "tmp/cache"
+      empty_directory "tmp/cache/assets"
+    end
+
+    def vendor
+      vendor_javascripts
+      vendor_stylesheets
+    end
+
+    def vendor_javascripts
+      empty_directory_with_gitkeep "vendor/assets/javascripts"
+    end
+
+    def vendor_stylesheets
+      empty_directory_with_gitkeep "vendor/assets/stylesheets"
+    end
+  end
+
+  module Generators
+    # We need to store the RAILS_DEV_PATH in a constant, otherwise the path
+    # can change in Ruby 1.8.7 when we FileUtils.cd.
+    RAILS_DEV_PATH = File.expand_path("../../../../../..", File.dirname(__FILE__))
+    RESERVED_NAMES = %w[application destroy benchmarker profiler plugin runner test]
+
+    class AppGenerator < AppBase
+      add_shared_options_for "application"
+      source_root File.expand_path("../templates", __FILE__)
+
+      # Add bin/rails options
+      class_option :version, :type => :boolean, :aliases => "-v", :group => :rails,
+                             :desc => "Show Rails version number and quit"
+
+      def initialize(*args)
+        raise Error, "Options should be given after the application name. For details run: rails --help" if args[0].blank?
+
+        super
+
+        if !options[:skip_active_record] && !DATABASES.include?(options[:database])
+          raise Error, "Invalid value for --database option. Supported for preconfiguration are: #{DATABASES.join(", ")}."
+        end
+      end
+
+      public_task :create_root
+
+      def create_root_files
+        build(:readme)
+        build(:rakefile)
+        build(:configru)
+        build(:gitignore) unless options[:skip_git]
+        build(:gemfile)   unless options[:skip_gemfile]
+      end
+
+      def create_app_files
+        build(:app)
+      end
+
+      def create_config_files
+        build(:config)
+      end
+
+      def create_boot_file
+        template "config/boot.rb"
+      end
+
+      def create_active_record_files
+        return if options[:skip_active_record]
+        build(:database_yml)
+      end
+
+      def create_db_files
+        build(:db)
+      end
+
+      def create_doc_files
+        build(:doc)
+      end
+
+      def create_lib_files
+        build(:lib)
+      end
+
+      def create_log_files
+        build(:log)
+      end
+
+      def create_public_files
+        build(:public_directory)
+      end
+
+      def create_script_files
+        build(:script)
+      end
+
+      def create_test_files
+        build(:test) unless options[:skip_test_unit]
+      end
+
+      def create_tmp_files
+        build(:tmp)
+      end
+
+      def create_vendor_files
+        build(:vendor)
+      end
+
+      def finish_template
+        build(:leftovers)
+      end
+
+      public_task :apply_rails_template, :run_bundle
+
+    protected
+
+      def self.banner
+        "lightrail new #{self.arguments.map(&:usage).join(' ')} [options]"
+      end
+
+      # Define file as an alias to create_file for backwards compatibility.
+      def file(*args, &block)
+        create_file(*args, &block)
+      end
+
+      def app_name
+        @app_name ||= defined_app_const_base? ? defined_app_name : File.basename(destination_root)
+      end
+
+      def defined_app_name
+        defined_app_const_base.underscore
+      end
+
+      def defined_app_const_base
+        Rails.respond_to?(:application) && defined?(Rails::Application) &&
+          Rails.application.is_a?(Rails::Application) && Rails.application.class.name.sub(/::Application$/, "")
+      end
+
+      alias :defined_app_const_base? :defined_app_const_base
+
+      def app_const_base
+        @app_const_base ||= defined_app_const_base || app_name.gsub(/\W/, '_').squeeze('_').camelize
+      end
+      alias :camelized :app_const_base
+
+      def app_const
+        @app_const ||= "#{app_const_base}::Application"
+      end
+
+      def valid_const?
+        if app_const =~ /^\d/
+          raise Error, "Invalid application name #{app_name}. Please give a name which does not start with numbers."
+        elsif RESERVED_NAMES.include?(app_name)
+          raise Error, "Invalid application name #{app_name}. Please give a name which does not match one of the reserved rails words."
+        elsif Object.const_defined?(app_const_base)
+          raise Error, "Invalid application name #{app_name}, constant #{app_const_base} is already in use. Please choose another application name."
+        end
+      end
+
+      def app_secret
+        SecureRandom.hex(64)
+      end
+
+      def mysql_socket
+        @mysql_socket ||= [
+          "/tmp/mysql.sock",                        # default
+          "/var/run/mysqld/mysqld.sock",            # debian/gentoo
+          "/var/tmp/mysql.sock",                    # freebsd
+          "/var/lib/mysql/mysql.sock",              # fedora
+          "/opt/local/lib/mysql/mysql.sock",        # fedora
+          "/opt/local/var/run/mysqld/mysqld.sock",  # mac + darwinports + mysql
+          "/opt/local/var/run/mysql4/mysqld.sock",  # mac + darwinports + mysql4
+          "/opt/local/var/run/mysql5/mysqld.sock",  # mac + darwinports + mysql5
+          "/opt/lampp/var/mysql/mysql.sock"         # xampp for linux
+        ].find { |f| File.exist?(f) } unless RbConfig::CONFIG['host_os'] =~ /mswin|mingw/
+      end
+
+      def get_builder_class
+        defined?(::AppBuilder) ? ::AppBuilder : Lightrail::AppBuilder
+      end
+    end
+  end
+end