gem_suit 0.1.0

data/lib/gem_suit/cli/builder.rb

@@ -0,0 +1,143 @@
+require "fileutils"
+require "gem_suit/cli/builder/rails_app"
+require "gem_suit/cli/builder/generator"
+
+module GemSuit
+  class CLI < Thor
+    module Builder
+
+      def self.included(base)
+        base.send :include, InstanceMethods
+      end
+
+      module InstanceMethods
+      private
+
+        TEST_SUITS = "{test}"
+        TEMP_DIR   = "tmp"
+
+        # `suit up`
+
+        def create_shared_assets
+          stash_test_suites
+          FileUtils.cp_r File.join(static_templates_path, "."), "."
+          move_test_suits
+        end
+
+        def stash_test_suites
+          return if Dir[TEST_SUITS].empty?
+          FileUtils.mkdir TEMP_DIR unless File.exists? TEMP_DIR
+
+          Dir[TEST_SUITS].each do |dir|
+            FileUtils.mv dir, TEMP_DIR
+          end
+        end
+
+        def move_test_suits
+          Dir["#{TEMP_DIR}/#{TEST_SUITS}"].each do |dir|
+            if File.basename(dir) == "test"
+              Dir["#{dir}/*"].each do |entry|
+                destination = File.expand_path "suit/shared/test"
+                if %w(fixtures integration unit).include? File.basename(entry)
+                  FileUtils.rm_rf File.expand_path(File.basename(entry), destination)
+                end
+                FileUtils.mv entry, destination
+              end
+              FileUtils.rmdir dir
+            else
+              destination = File.expand_path "suit/shared/#{File.basename(dir)}"
+              FileUtils.rm destination if File.exists? destination
+              FileUtils.mv dir, destination
+            end
+          end
+
+          Dir["#{TEMP_DIR}/**/.DS_Store"].each do |file|
+            FileUtils.rm file
+          end
+
+          FileUtils.rmdir TEMP_DIR if File.exists? TEMP_DIR
+        end
+
+        def create_rails_apps
+          suit_config_global[:rails_versions].each do |version|
+            Builder::RailsApp.new(version, self).install
+          end
+        end
+
+        def generate_files
+          Builder::Generator.new(self).run
+        end
+
+        # `suit fit`
+
+        def bundle_install
+          return if `bundle check`.none?{|line| line.include? "`bundle install`"}
+          puts "Running `bundle install` (this can take several minutes...)".yellow
+          puts "(in #{File.expand_path("")})"
+          `bundle install`
+        end
+
+        def bundle_install_apps
+          Dir["suit/rails-*/dummy"].each do |rails_root|
+            Object.send :remove_const, :SuitApplication
+            require File.expand_path("test/suit_application.rb", rails_root)
+            SuitApplication.bundle_install
+          end
+        end
+
+        def rake_install
+          return if Dir["rails_generators"].empty?
+          cmd = "rake install"
+          log "Running 'rake install' in order to be able to run the Rails 2 generators".green
+          log cmd
+          `#{cmd}`
+        end
+
+        def ask_mysql_password
+          return unless suit_config.mysql?
+
+          log "Setting up the MySQL test database".green
+          log "To be able to run integration tests (with Capybara in Firefox) we need to store your MySQL password in a git-ignored file (suit/shared/mysql)"
+          log "Please provide the password of your MySQL root user: (press Enter when blank)", true
+
+          begin
+            system "stty -echo"
+            password = STDIN.gets.strip
+          ensure
+            system "stty echo"
+          end
+
+          file = "suit/shared/mysql"
+          if password.length == 0
+            File.delete file if File.exists? file
+          else
+            File.open(file, "w"){|f| f << password}
+            log "\n"
+          end
+        end
+
+        def create_mysql_test_database
+          return unless suit_config.mysql?
+
+          rails_root = Dir["suit/rails-*/dummy"].max
+          log "Creating the test database".green
+          log "cd #{rails_root} && RAILS_ENV=test rake db:create"
+
+          require File.expand_path("test/suit_application.rb", rails_root)
+          SuitApplication.create_test_database
+        end
+
+        def create_development_databases
+          Dir["suit/rails-*/dummy"].each do |rails_root|
+            cmd     = "cd #{rails_root} && rake db:setup"
+            version = rails_root.match(/suit\/([^\/]*)\//).captures[0].capitalize.gsub "-", " "
+            log     "Creating Rails #{version} development database".green
+            log     cmd
+            execute cmd
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/gem_suit/cli/config/hash.rb

@@ -0,0 +1,61 @@
+require "yaml"
+
+module GemSuit
+  class CLI < Thor
+    module Config
+
+      class Hash
+        def initialize(file, default = {})
+          @filename = file
+          @hash ||= ::Thor::CoreExt::HashWithIndifferentAccess.new File.exists?(@filename) ? YAML.load_file(@filename) : default
+        end
+
+        def dump
+          YAML.dump hash.inject({}){|h, (k, v)| h[k.to_sym] = v; h}
+        end
+
+        def to_str
+          hash.collect do |key, value|
+            val = case value.class.name
+                  when "Array"
+                    value.join ","
+                  else
+                    value
+                  end
+            "#{key}=#{val}"
+          end.join "\n"
+        end
+
+        def [](key)
+          hash[key]
+        end
+
+        def []=(key, value)
+          hash[key] = value
+          dump_file
+        end
+
+      private
+
+        def method_missing(method, *args)
+          if hash.respond_to?(method) || method.to_s =~ /^(\w+)\?$/
+            hash.send method, *args
+          else
+            super
+          end
+        end
+
+        def hash
+          @hash
+        end
+
+        def dump_file
+          File.open @filename, "w" do |file|
+            file << dump
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/gem_suit/cli/config.rb

@@ -0,0 +1,37 @@
+require "gem_suit/cli/config/hash"
+
+module GemSuit
+  class CLI < Thor
+    module Config
+
+      FILENAME = ".suit"
+
+      def self.included(base)
+        base.send :include, InstanceMethods
+      end
+
+      module InstanceMethods
+
+        def configure_suit
+          suit_config[:mysql]    = options.key?("mysql")    ? options.mysql    : agree?("Do you want to use a MySQL test database?", :no)
+          suit_config[:capybara] = options.key?("capybara") ? options.capybara : agree?("Do you want to use Capybara for testing?" , :yes)
+          suit_config[:version]  = GemSuit::VERSION::STRING
+        end
+
+        def suit_config_global
+          @suit_config_global ||= Config::Hash.new File.expand_path(FILENAME, suit_gem_path)
+        end
+
+        def suit_config
+          @suit_config ||= Config::Hash.new FILENAME, suit_config_global
+        end
+
+        def suit_config?
+          File.exists? FILENAME
+        end
+
+      end
+
+    end
+  end
+end

data/lib/gem_suit/cli.rb

@@ -0,0 +1,145 @@
+require "thor"
+require "rich/support/core/string/colorize"
+require "gem_suit/cli/base"
+require "gem_suit/cli/config"
+require "gem_suit/cli/builder"
+require "gem_suit/cli/application"
+require "gem_suit/version"
+
+module GemSuit
+  class CLI < Thor
+
+    class Error < StandardError; end
+
+    include Base
+    include Config
+    include Builder
+    include Application
+
+    default_task :test
+
+    desc "tailor NAME", "Generate a Bundler gem and provide it with GemSuit"
+    method_options [:interactive, "-i"] => false, [:extras, "-e"] => true, [:mysql, "-m"] => :boolean, [:capybara, "-c"] => :boolean, [:verbose, "-v"] => false
+    def tailor(name)
+      execute "bundle gem #{name}"
+
+      opts = options.collect do |key, value|
+        ["-", ("-no" unless value), "-#{key}"].compact.join "" if [:interactive, :extras, :mysql, :capybara, :verbose].include?(key.to_sym)
+      end.compact.join " "
+
+      system "cd #{name} && suit up #{opts}"
+    end
+
+    desc "up", "Provide an existing gem with GemSuit"
+    method_options [:interactive, "-i"] => false, [:extras, "-e"] => true, [:mysql, "-m"] => :boolean, [:capybara, "-c"] => :boolean, [:verbose, "-v"] => false
+    def up
+      assert_gem_dir true
+      create_shared_assets
+      configure_suit
+      create_rails_apps
+      generate_files
+
+      opts = options.collect do |key, value|
+        ["-", ("-no" unless value), "-#{key}"].compact.join "" if [:verbose].include?(key.to_sym)
+      end.compact.join " "
+
+      system "suit fit #{opts} --no-rake_install"
+      puts "Barney Stinson says: 'Cheers! Your gem just got a little more legend!'".green
+    end
+
+    # desc "check", "Check whether GemSuit requirements are satisfied"
+    # def check
+    #   assert_suit_dir
+    #   # Do we have all the Rails dummy apps installed?
+    #   # Barney says: 'Your gem is already awesome' || Barney says: 'Run `suit up` to be more legend'
+    # end
+
+    desc "fit", "Establish the GemSuit in your environment"
+    method_options [:rake_install, "-i"] => true, [:verbose, "-v"] => false
+    def fit
+      assert_suit_dir
+      restore
+      bundle_install
+      bundle_install_apps
+      rake_install if options.rake_install?
+      ask_mysql_password
+      create_mysql_test_database
+      create_development_databases
+    end
+
+    desc "config [global]", "Configure GemSuit within your gem (use `suit config global` for global config)"
+    method_options [:rails_versions, "-r"] => :array, [:mysql, "-m"] => :boolean, [:capybara, "-c"] => :boolean
+    def config(env = nil)
+      global_options = [:rails_versions]
+      case env
+      when "global"
+        if options.empty?
+          log suit_config_global.to_str, true
+        else
+          options.reject{|k, v| !global_options.include? k.to_sym}.each do |key, value|
+            suit_config_global[key] = value
+          end
+        end
+      when nil
+        assert_suit_dir
+        if options.empty?
+          log suit_config.to_str, true
+        else
+          options.reject{|k, v| global_options.include? k.to_sym}.each do |key, value|
+            suit_config[key] = value
+          end
+        end
+      else
+        raise Error, "Invalid config enviroment #{env.inspect}"
+      end
+    end
+
+    desc "server [ENVIRONMENT]", "Start one of the GemSuit test application servers"
+    method_options [:rails_version, "-r"] => :integer, [:port, "-p"] => :integer
+    map "s" => :server
+    def server(environment = "development")
+      rails :server, environment
+    end
+
+    desc "console [ENVIRONMENT]", "Start one of the GemSuit test application consoles"
+    method_options [:rails_version, "-r"] => :integer
+    map "c" => :console
+    def console(environment = "development")
+      rails :console, environment
+    end
+
+    desc "test [SECTION] [FILES]", "Run GemSuit (suit, unit, functional, integration) tests"
+    method_options [:rails_versions, "-r"] => :array, [:verbose, "-v"] => false, [:very_verbose, "-w"] => false
+    def test(section = "suit", file_or_pattern = nil)
+      if Application::InstanceMethods.instance_methods.include?(method = "test_#{section}")
+        send method, file_or_pattern
+      elsif file_or_pattern.nil?
+        test_suit section
+      else
+        raise Error, "Unrecognized test section '#{section}'. Either leave it empty or pass 'suit', 'unit', 'functional' or 'integration'"
+      end
+    end
+
+    desc "restore", "Restore all files within the GemSuit test applications"
+    method_options [:verbose, "-v"] => false
+    def restore
+      files :restore
+    end
+
+    desc "bundle", "Run `bundle install` (should be invoked from a Rails dummy application) only when necessary (used for testing)"
+    def bundle
+      assert_rails_dir
+      if `bundle check`.any?{|line| line.include? "`bundle install`"}
+        puts "Running `bundle install` (this can take several minutes...)".yellow
+        system "bundle install"
+      end
+    end
+
+  private
+
+    def method_missing(method, *args)
+      raise Error, "Unrecognized command \"#{method}\". Please consult `suit help`."
+    end
+
+  end
+end

data/lib/gem_suit/integration_test.rb

@@ -0,0 +1,14 @@
+# http://techiferous.com/2010/04/using-capybara-in-rails-3 FTW!
+
+require "capybara/rails"
+
+module GemSuit
+  class IntegrationTest < ::ActionController::IntegrationTest
+    include Capybara
+  end
+end
+
+Capybara.register_driver(driver = :"selenium_firefox") do |app|
+  Capybara::Driver::Selenium.new app, :profile => "default"
+end
+Capybara.default_driver = driver

data/lib/gem_suit/test_help.rb

@@ -0,0 +1,17 @@
+ENV["RAILS_ENV"] = "test"
+
+caller_dir = File.dirname(caller.detect{|x| !x.include? "custom_require.rb"})
+rails_root = File.expand_path "..", caller_dir
+rails_root = File.expand_path Dir["#{caller_dir}/../../rails-*/dummy"].last unless File.exists? "#{rails_root}/config/environment.rb"
+gem_dir    = File.expand_path "../../..", rails_root
+
+system "cd #{gem_dir}    && suit restore"
+system "cd #{rails_root} && suit bundle"
+
+begin
+  require "#{rails_root}/config/environment"
+rescue LoadError => e
+  puts "ERROR: #{e.message}\n\n"
+end
+
+require "#{"rails/" if Rails::VERSION::MAJOR >= 3}test_help"

data/lib/gem_suit/version.rb

@@ -0,0 +1,9 @@
+module GemSuit
+  module VERSION
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join(".")
+  end
+end

data/lib/gem_suit.rb

@@ -0,0 +1,6 @@
+require "gem_suit/version"
+
+module GemSuit
+  autoload :Application    , "gem_suit/application"
+  autoload :IntegrationTest, "gem_suit/integration_test"
+end

data/templates/dynamic/CHANGELOG.rdoc

@@ -0,0 +1,5 @@
+= <%= camelize gem_name %> CHANGELOG
+
+== Version 0.0.1 (<%= Time.now.strftime "%B xxx, %Y" %>)
+
+* Initial release

data/templates/dynamic/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+gem "rails", "<%= rails_gem_version %>"
+gem "sqlite3-ruby", :require => "sqlite3"
+
+gem "<%= gem_name %>", :path => File.expand_path("../../../..", __FILE__)
+
+group :test do
+  gem "mysql"
+  gem "shoulda"
+  gem "mocha"
+  gem "capybara"
+  gem "launchy"
+end

data/templates/dynamic/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) <%= Time.now.strftime "%Y" %> <%= author %>
+
+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/templates/dynamic/README.textile

@@ -0,0 +1,35 @@
+h1. <%= camelize gem_name %>
+
+Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor.
+
+h2. Introduction
+
+Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+
+h2. Installation
+
+Run the following command in your console:
+
+<pre>
+  gem install <%= gem_name %>
+</pre>
+
+h2. Usage
+
+Lorem ipsum.
+
+h2. Contact me
+
+For support, remarks and requests please mail me at "<%= email %>":mailto:<%= email %>.
+
+h2. License
+
+Copyright (c) <%= Time.now.strftime "%Y" %> <%= author %>, released under the MIT license
+
+<% unless twitter.empty? %>"http://twitter.com/<%= twitter %>":http://twitter.com/<%= twitter %> – <% end %>"<%= email %>":mailto:<%= email %>
+
+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/templates/dynamic/VERSION

@@ -0,0 +1 @@
+0.0.1

data/templates/dynamic/config/boot.rb

@@ -0,0 +1,13 @@
+class Rails::Boot
+  def run
+    load_initializer
+
+    Rails::Initializer.class_eval do
+      def load_gems
+        @bundler_loaded ||= Bundler.require :default, Rails.env
+      end
+    end
+
+    Rails::Initializer.run(:set_load_path)
+  end
+end

data/templates/dynamic/config/preinitializer.rb

@@ -0,0 +1,20 @@
+begin
+  require "rubygems"
+  require "bundler"
+rescue LoadError
+  raise "Could not load the bundler gem. Install it with `gem install bundler`."
+end
+
+if Gem::Version.new(Bundler::VERSION) <= Gem::Version.new("0.9.24")
+  raise RuntimeError, "Your bundler version is too old for Rails 2.3." +
+   "Run `gem install bundler` to upgrade."
+end
+
+begin
+  # Set up load paths for all bundled gems
+  ENV["BUNDLE_GEMFILE"] = File.expand_path("../../Gemfile", __FILE__)
+  Bundler.setup
+rescue Bundler::GemNotFound
+  raise RuntimeError, "Bundler couldn't find some gems." +
+    "Did you run `bundle install`?"
+end

data/templates/dynamic/gitignore

@@ -0,0 +1,9 @@
+.DS_Store
+.bundle
+*.gem
+Gemfile.lock
+pkg/*
+suit/rails-*/dummy/db/test.sqlite3
+suit/rails-*/dummy/log/*.log
+suit/rails-*/dummy/tmp/*
+suit/shared/mysql

data/templates/dynamic/suit/shared/app/views/application/index.html.erb

@@ -0,0 +1,16 @@
+<div class="content">
+  <h1><%= camelize gem_name %> <%%= Rails.env %> app</h1>
+  <div class="left">
+    <p>
+      Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+    </p>
+  </div>
+  <ul>
+    <li>
+      <%%= link_to "Home", "/" %>
+    </li>
+    <li>
+      <%%= link_to "GemSuit", "https://github.com/archan937/gem_suit" %>
+    </li>
+  </ul>
+</div>

data/templates/dynamic/suit/shared/public/stylesheets/app.css

@@ -0,0 +1,99 @@
+* {
+  margin: 0;
+  padding: 0;
+  outline: 0; }
+
+html, body {
+  height: 100%; }
+
+body {
+  color: #111;
+  font-family: Myriad Pro, Arial;
+  font-size: 18px;
+  line-height: 120%;
+  text-shadow: white 0 2px 0;
+  background: #E0E0E0; }
+
+ol, ul {
+  list-style: none; }
+
+a {
+  padding-bottom: 1px;
+  color: #111;
+  cursor: pointer;
+  text-decoration: none; }
+
+a:hover {
+  text-decoration: underline; }
+
+abbr, fieldset, img {
+  border: 0; }
+
+textarea {
+  font-family: Myriad Pro, Arial; }
+
+#page {
+  width: 750px;
+  min-height: 100%;
+  margin: 0 auto; }
+
+#page div.locales {
+  padding-top: 80px;
+  text-align: center; }
+
+#page div.locales a img {
+  margin: 0 2px;
+  padding: 2px; }
+
+#page div.locales a.selected img {
+  padding: 1px;
+  border: 1px solid #06F; }
+
+#page div.content {
+  padding-top: 80px;
+  clear: both; }
+
+#page div.content h1 {
+  margin-bottom: 35px; }
+
+#page div.content div.left {
+  width: 515px;
+  float: left; }
+
+#page div.content div.left h3 {
+  font-size: 22px;
+  margin-bottom: 22px; }
+
+#page div.content div.left p {
+  margin-bottom: 30px;
+  font-size: 18px;
+  line-height: 140%; }
+
+#page div.content div.left form label {
+  display: block;
+  font-weight: bold; }
+
+#page div.content div.left form .inputs input {
+  margin-bottom: 15px;
+  width: 350px;
+  font-size: 16px; }
+
+#page div.content div.left form .inputs textarea {
+  width: 400px;
+  height: 150px;
+  font-size: 18px; }
+
+#page div.content div.left form .buttons {
+  padding: 15px 0 60px 0; }
+
+#page div.content div.left form .buttons input {
+  margin-right: 6px;
+  font-size: 16px; }
+
+#page div.content div.left form .buttons a {
+  font-size: 14px; }
+
+#page div.content ul {
+  width: 175px;
+  font-weight: bold;
+  float: right; }