gemsmith 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f099b61afd087c4dc64b7850b0d5f1d69130b11
-  data.tar.gz: d7078655ebcc3e7f4ae7528be679573a47fb638c
+  metadata.gz: 844ed51e2c822e23c4c5f2ec59783a872d56f86b
+  data.tar.gz: c4a454c20bb5f7085ba732d0a417b34419249395
 SHA512:
-  metadata.gz: db87fed1447b0b7a73c93f8459c482faeed8f2e0d10872b412e1b2266013552d2d566eb213053b0618b7ee29f56ce6069010c3a5d59e34a88ff9e05a067efc02
-  data.tar.gz: e87478defe7ab4402bcc565db390d7bd139bf310592dbdf53427c808001d7ad0c366efed332c7324c7a1536c7fa0b74de8e32ebcfebd3c66b08c3d1a113b8b9a
+  metadata.gz: a96e1522f52d68759bd1c3d406e73532806d9298ce5ff541e460ff223e27a7baa5cc9e8daffcc1032909c66fb099869ee429b2faa1e01f9a949d2722277a5525
+  data.tar.gz: 6fd9d55827af7153afa0e40b21411f6b91785ac15a8ec832c92337845714346ea4a21e3bb3007185be150393e8756ee59b5d320c875bf9b4eaf595583975ecff

data/{LICENSE.rdoc → LICENSE.md}

@@ -1,4 +1,4 @@
-Copyright (c) 2011 {Red Alchemist}[http://www.redalchemist.com].
+Copyright (c) 2011 [Red Alchemist](http://www.redalchemist.com).
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,154 @@
+# Overview
+
+[![Gem Version](https://badge.fury.io/rb/gemsmith.png)](http://badge.fury.io/rb/gemsmith)
+[![Code Climate GPA](https://codeclimate.com/github/bkuhlmann/gemsmith.png)](https://codeclimate.com/github/bkuhlmann/gemsmith)
+[![Travis CI Status](https://secure.travis-ci.org/bkuhlmann/gemsmith.png)](http://travis-ci.org/bkuhlmann/gemsmith)
+
+Gemsmith allows you to easily craft new gems via the command line with custom settings (if desired). If you are
+a fan of [Bundler](https://github.com/carlhuda/bundler), then you'll appreciate the additional capabilities of this
+gem. Gemsmith is essentially an enhanced version of Bundler's gem building capabilities.
+
+# Features
+
+* Builds a gem skeleton with Bundler functionality in mind.
+* Supports common settings that can be applied to new gem creations.
+* Supports binary skeletons with [Thor](https://github.com/wycats/thor) command line functionality.
+* Supports [Ruby on Rails](http://rubyonrails.org).
+* Supports [RSpec](http://rspec.info).
+* Supports [Pry](http://pryrepl.org).
+* Supports [Guard](https://github.com/guard/guard).
+* Supports [Code Climate](https://codeclimate.com).
+* Supports [Travis CI](http://travis-ci.org) skeletons.
+* Adds commonly needed README, CHANGELOG, LICENSE, etc. template files.
+* Provides the ability to open any installed gem within your favorite editor.
+
+# Requirements
+
+1. A UNIX-based system.
+2. [Ruby 2.0.x](http://www.ruby-lang.org).
+3. [RubyGems](http://rubygems.org).
+4. [Bundler](https://github.com/carlhuda/bundler).
+
+# Setup
+
+Type the following from the command line to install:
+
+    gem install gemsmith
+
+You can configure common settings for future gem builds by creating the following file:
+
+    ~/.gemsmith/settings.yml
+
+...using the following settings (for example):
+
+    ---
+    :author_name: Brooke Kuhlmann
+    :author_email: brooke@redalchemist.com
+    :author_url: http://www.redalchemist.com
+    :company_name: Red Alchemist
+
+If no options are configured, then the defaults are as follows:
+
+    gem_platform: Gem::Platform::RUBY
+    author_name: <git name>
+    author_email: <git email>
+    author_url: https://www.unknown.com
+    gem_url: <author URL>
+    company_name: <author name>
+    company_url: <author URL>
+    github_user: <github user>
+    year: <current year>
+    ruby_version: 2.0.0
+    ruby_patch: p0
+    rails_version: 3.2.0
+
+# Usage
+
+From the command line, type: gemsmith help
+
+    gemsmith -c, [create=GEM_NAME]  # Create new gem.
+    gemsmith -e, [edit]             # Edit gem settings in default editor (assumes $EDITOR environment variable).
+    gemsmith -h, [help]             # Show this message.
+    gemsmith -o, [open=NAME]        # Opens gem in default editor (assumes $EDITOR environment variable).
+    gemsmith -r, [read=NAME]        # Opens gem in default browser.
+    gemsmith -v, [version]          # Show version.
+
+For more gem creation options, type: gemsmith help create
+
+    -b, [--bin]           # Add binary support.
+    -r, [--rails]         # Add Rails support.
+    -p, [--pry]           # Add Pry support.
+                          # Default: true
+    -g, [--guard]         # Add Guard support.
+                          # Default: true
+    -s, [--rspec]         # Add RSpec support.
+                          # Default: true
+    -t, [--travis]        # Add Travis CI support.
+                          # Default: true
+    -c, [--code-climate]  # Add Code Climate support.
+                          # Default: true
+
+Also, don't forget that once you have created your gem skeleton, the following rake tasks are also
+available to you via Bundler (i.e. rake -T):
+
+    rake build    # Build <gem>-<version>.gem into the pkg directory
+    rake install  # Build and install <gem>-<version>.gem into system gems
+    rake release  # Create tag v0.1.1 and build and push <gem>-<version>.gem to Rubygems
+
+# Tests
+
+To test, do the following:
+
+0. cd to the gem root.
+0. bundle install
+0. bundle exec rspec spec
+
+# Best Practices
+
+0. [Semantic Versioning](http://semver.org)
+0. [Best Practices While Cutting Gems](http://rubysource.com/crafting-rubies-best-practices-while-cutting-gems).
+0. [Ruby on Rails Gem Packaging](http://weblog.rubyonrails.org/2009/9/1/gem-packaging-best-practices).
+0. [Gem Activation and You: Part I](http://erik.hollensbe.org/2013/05/11/gem-activation-and-you)
+0. [Gem Activation and You: Part II](http://erik.hollensbe.org/2013/05/15/gem-activation-and-you-part-2-bundler-and-binstubs)
+0. [Why You Should Use a BSD Style License](http://www.freebsd.org/doc/en/articles/bsdl-gpl/article.html).
+0. Add -w to the RUBYOPT environment variable when testing. [Details](http://avdi.org/devblog/2011/06/23/how-ruby-helps-you-fix-your-broken-code).
+
+## When To Include a Railtie ([Crafting Rails Applications](http://pragprog.com/book/jvrails/crafting-rails-applications) - Page 93 by José Valim)
+
+* "Your gem needs to perform a given task while or after the Rails application is initialized."
+* "Your gem needs to change a configuration value, such as setting a generator."
+* "Your gem must provide Rake tasks and generators in nondefault locations (the default location for the former is lib/tasks and lib/gen- erators or lib/rails/generators for the latter)."
+* "You want your gem to provide configuration options to the appli- cation, such as config.my_gem.key # :value."
+
+# Documentation
+
+In order to make your gem easier to use and adopt by others, good documentation is always a plus. Consider submitting
+your gem to RubyDocs[http://rubydoc.info] once your gem is released and available for use. RubyDocs supports both
+RDoc and YARD formats.
+
+# Promotion
+
+Once your gem is released, you might like to let the world know about the new awesomeness. Here are several resources:
+
+* [How to Spread the Word About Your Code](https://hacks.mozilla.org/2013/05/how-to-spread-the-word-about-your-code)
+* [Ruby Toolbox](https://www.ruby-toolbox.com)
+* [RubyFlow](http://www.rubyflow.com)
+* [The Ruby Show](http://rubyshow.com)
+* [Ruby 5](http://ruby5.envylabs.com)
+
+# Contributions
+
+Read CONTRIBUTING for details.
+
+# Credits
+
+Developed by [Brooke Kuhlmann](http://www.redalchemist.com) at [Red Alchemist](http://www.redalchemist.com).
+
+# License
+
+Copyright (c) 2011 [Red Alchemist](http://www.redalchemist.com).
+Read the LICENSE for details.
+
+# History
+
+Read the CHANGELOG for details.

data/lib/gemsmith.rb

@@ -1,2 +1,2 @@
-require File.join File.dirname(__FILE__), "gemsmith", "version.rb"
-require File.join File.dirname(__FILE__), "gemsmith", "kit.rb"
+require "gemsmith/version"
+require "gemsmith/kit"

data/lib/gemsmith/cli.rb

@@ -2,22 +2,35 @@ require "yaml"
 require "thor"
 require "thor/actions"
 require "thor_plus/actions"
+require "gemsmith/cli_options"
+require "gemsmith/cli_helpers"
+require "gemsmith/skeletons/base_skeleton"
+require "gemsmith/skeletons/default_skeleton"
+require "gemsmith/skeletons/documentation_skeleton"
+require "gemsmith/skeletons/cli_skeleton"
+require "gemsmith/skeletons/rails_skeleton"
+require "gemsmith/skeletons/rspec_skeleton"
+require "gemsmith/skeletons/travis_skeleton"
+require "gemsmith/skeletons/git_skeleton"
 
 module Gemsmith
   class CLI < Thor
     include Thor::Actions
     include ThorPlus::Actions
+    include CLIOptions
+    include CLIHelpers
 
     # Overwrites the Thor template source root.
     def self.source_root
       File.expand_path File.join(File.dirname(__FILE__), "templates")
     end
-    
+
     # Initialize.
     def initialize args = [], options = {}, config = {}
       super args, options, config
       @settings_file = File.join ENV["HOME"], ".gemsmith", "settings.yml"
       @settings = load_yaml @settings_file
+      @template_options = {}
     end
 
     desc "-c, [create=GEM_NAME]", "Create new gem."
@@ -32,105 +45,32 @@ module Gemsmith
     def create name
       say
       info "Creating gem..."
-      
-      # Initialize options.
-      template_options = build_template_options name, @settings, options
-      gem_name = template_options[:gem_name]
-
-      # Configure templates.
-      target_path = File.join Dir.pwd, gem_name
-      
-      # Default templates.
-      template "README.rdoc.tmp", File.join(target_path, "README.rdoc"), template_options
-      template "CONTRIBUTING.md.tmp", File.join(target_path, "CONTRIBUTING.md"), template_options
-      template "LICENSE.rdoc.tmp", File.join(target_path, "LICENSE.rdoc"), template_options
-      template "CHANGELOG.rdoc.tmp", File.join(target_path, "CHANGELOG.rdoc"), template_options
-      template "Gemfile.tmp", File.join(target_path, "Gemfile"), template_options
-      template "Rakefile.tmp", File.join(target_path, "Rakefile"), template_options
-      template "gitignore.tmp", File.join(target_path, ".gitignore"), template_options
-      template "gem.gemspec.tmp", File.join(target_path, "#{gem_name}.gemspec"), template_options
-      template File.join("lib", "gem.rb.tmp"), File.join(target_path, "lib", "#{gem_name}.rb"), template_options
-      template File.join("lib", "gem", "version.rb.tmp"), File.join(target_path, "lib", gem_name, "version.rb"), template_options
-      
-      # Binary (optional).
-      if template_options[:bin]
-        template File.join("bin", "gem.tmp"), File.join(target_path, "bin", gem_name), template_options
-        template File.join("lib", "gem", "cli.rb.tmp"), File.join(target_path, "lib", gem_name, "cli.rb"), template_options
-      end
-
-      # Ruby on Rails (optional).
-      if template_options[:rails]
-        # ActionController
-        template File.join("lib", "gem", "action_controller", "class_methods.rb.tmp"), File.join(target_path, "lib", gem_name, "action_controller", "class_methods.rb"), template_options
-        template File.join("lib", "gem", "action_controller", "instance_methods.rb.tmp"), File.join(target_path, "lib", gem_name, "action_controller", "instance_methods.rb"), template_options
-        # ActionView
-        template File.join("lib", "gem", "action_view", "instance_methods.rb.tmp"), File.join(target_path, "lib", gem_name, "action_view", "instance_methods.rb"), template_options
-        # ActiveRecord
-        template File.join("lib", "gem", "active_record", "class_methods.rb.tmp"), File.join(target_path, "lib", gem_name, "active_record", "class_methods.rb"), template_options
-        template File.join("lib", "gem", "active_record", "instance_methods.rb.tmp"), File.join(target_path, "lib", gem_name, "active_record", "instance_methods.rb"), template_options
-        # Generators
-        empty_directory File.join(target_path, "lib", "generators", gem_name, "templates")
-        template File.join("lib", "generators", "gem", "install", "install_generator.rb.tmp"), File.join(target_path, "lib", "generators", gem_name, "install", "install_generator.rb"), template_options
-        template File.join("lib", "generators", "gem", "install", "USAGE.tmp"), File.join(target_path, "lib", "generators", gem_name, "install", "USAGE"), template_options
-        template File.join("lib", "generators", "gem", "upgrade", "upgrade_generator.rb.tmp"), File.join(target_path, "lib", "generators", gem_name, "upgrade", "upgrade_generator.rb"), template_options
-        template File.join("lib", "generators", "gem", "upgrade", "USAGE.tmp"), File.join(target_path, "lib", "generators", gem_name, "upgrade", "USAGE"), template_options
-        # Travis CI (optional).
-        if template_options[:travis]
-          template File.join("gemfiles", "rails-3.0.x.gemfile.tmp"), File.join(target_path, "gemfiles", "rails-3.0.x.gemfile"), template_options
-          template File.join("gemfiles", "rails-3.1.x.gemfile.tmp"), File.join(target_path, "gemfiles", "rails-3.1.x.gemfile"), template_options
-          template File.join("gemfiles", "rails-3.2.x.gemfile.tmp"), File.join(target_path, "gemfiles", "rails-3.2.x.gemfile"), template_options
-        end
-      end
 
-      # RSpec (optional).
-      if template_options[:rspec]
-        template "rspec.tmp", File.join(target_path, ".rspec"), template_options
-        template File.join("spec", "spec_helper.rb.tmp"), File.join(target_path, "spec", "spec_helper.rb"), template_options
-        template File.join("spec", "gem_spec.rb.tmp"), File.join(target_path, "spec", "#{gem_name}_spec.rb"), template_options
-      end
+      initialize_template_options name, options
+      Skeletons::DefaultSkeleton.run self
+      Skeletons::DocumentationSkeleton.run self
+      Skeletons::CLISkeleton.run(self) if template_options[:bin]
+      Skeletons::RailsSkeleton.run(self) if template_options[:rails]
+      Skeletons::RspecSkeleton.run(self) if template_options[:rspec]
+      Skeletons::TravisSkeleton.run(self) if template_options[:travis]
+      Skeletons::GitSkeleton.run self
 
-      # Travis CI (optional).
-      if template_options[:travis]
-        template "travis.yml.tmp", File.join(target_path, ".travis.yml"), template_options
-      end
-      
-      # Git
-      Dir.chdir(target_path) do
-        `git init`
-        `git add .`
-        `git commit -a -n -m "Gemsmith skeleton created."`
-      end
-      
       info "Gem created."
       say
     end
-    
+
     desc "-o, [open=NAME]", "Opens gem in default editor (assumes $EDITOR environment variable)."
     map "-o" => :open
     def open name
-      specs = Gem::Specification.find_all_by_name name
-      case
-      when specs.size == 1
-        `$EDITOR #{specs.first.full_gem_path}`
-      when specs.size > 1
-        say "Multiple versions found:"
-        specs.each_with_index do |spec, index|
-          say "#{index + 1}. #{spec.name} #{spec.version.version}"
-        end
-        result = ask "Please pick one (or type 'q' to quit):"
-        unless result == 'q'
-          if (1..specs.size).include?(result.to_i)
-            spec = Gem::Specification.find_by_name(name, specs[result.to_i - 1].version.version)
-            `$EDITOR #{spec.full_gem_path}`
-          else
-            error "Invalid option: #{result}"
-          end
-        end
-      else
-        say "Unable to find gem: #{name}"
-      end
+      process_gem name, "open"
+    end
+
+    desc "-r, [read=NAME]", "Opens gem in default browser."
+    map "-r" => :read
+    def read name
+      process_gem name, "read"
     end
-    
+
     desc "-e, [edit]", "Edit gem settings in default editor (assumes $EDITOR environment variable)."
     map "-e" => :edit
     def edit
@@ -142,49 +82,10 @@ module Gemsmith
     def version
       say "Gemsmith " + VERSION
     end
-    
+
     desc "-h, [help]", "Show this message."
     def help task = nil
       say and super
     end
-
-    private
-
-    # Builds template options with default and/or custom settings (where the custom
-    # settings trump default settings).
-    # ==== Parameters
-    # * +gem_name+ - Required. The gem name.
-    # * +settings+ - Optional. The custom settings. Default: {}.
-    # * +options+ - Optional. Additional command line options. Default: {}.
-    def build_template_options gem_name, settings = {}, options = {}
-      gem_name = Thor::Util.snake_case gem_name
-      gem_class = Thor::Util.camel_case gem_name
-      author_name = settings[:author_name] || Gemsmith::Kit.git_config_value("user.name") || "TODO: Add full name here."
-      author_email = settings[:author_email] || Gemsmith::Kit.git_config_value("user.email") || "TODO: Add email address here."
-      author_url = settings[:author_url] || "https://www.unknown.com"
-      {
-        gem_name: gem_name,
-        gem_class: gem_class,
-        gem_platform: (settings[:gem_platform] || "Gem::Platform::RUBY"),
-        author_name: author_name,
-        author_email: author_email,
-        author_url: (author_url || "http://www.unknown.com"),
-        gem_url: (settings[:gem_url] || author_url),
-        company_name: (settings[:company_name] || author_name),
-        company_url: (settings[:company_url] || author_url),
-        github_user: (settings[:github_user] || Gemsmith::Kit.git_config_value("github.user") || "unknown"),
-        year: (settings[:year] || Time.now.year),
-        ruby_version: (settings[:ruby_version] || "2.0.0"),
-        rails_version: (settings[:rails_version] || "3.0"),
-        post_install_message: settings[:post_install_message],
-        bin: (options[:bin] || false),
-        rails: (options[:rails] || false),
-        pry: (options[:pry] || true),
-        guard: (options[:guard] || true),
-        rspec: (options[:rspec] || true),
-        travis: (options[:travis] || true),
-        code_climate: (options[:code_climate] || true)
-      }
-    end
   end
 end

data/lib/gemsmith/cli_helpers.rb

@@ -0,0 +1,90 @@
+module Gemsmith
+  module CLIHelpers
+    # Answers the gem name (snake case).
+    # ==== Parameters
+    # * +name+ - Optional. The gem name. Default: nil
+    def gem_name name = nil
+      @gem_name ||= Thor::Util.snake_case name
+    end
+
+    # Answers the gem class (camel case).
+    # ==== Parameters
+    # * +name+ - Optional. The gem class. Default: nil
+    def gem_class name = nil
+      @gem_class ||= Thor::Util.camel_case name
+    end
+
+    # Answers all gem template options.
+    def template_options
+      @template_options
+    end
+
+    module_function
+
+    # Converts hash keys from strings to symbols (if any).
+    # ===== Parameters
+    # * +options+ - Optional. The hash to convert. Default: {}
+    def enforce_symbol_keys options = {}
+      options.each_with_object({}) { |(key, value), hash| hash[key.to_sym] = value }
+    end
+
+    # Prints currently installed gem name and version information.
+    # ===== Parameters
+    # * +gems+ - Required. The array of gem names (i.e. gem specifications).
+    def print_gems gems
+      say "Multiple versions found:"
+      gems.each_with_index do |spec, index|
+        say "#{index + 1}. #{spec.name} #{spec.version.version}"
+      end
+    end
+
+    # Picks a gem specification for processing.
+    # ===== Parameters
+    # * +gems+ - Required. The array of gem specifications.
+    # * +name+ - Required. The gem name to search for.
+    def pick_gem gems, name
+      result = ask "Please pick one (or type 'q' to quit):"
+
+      return if result == 'q' # Exit early.
+
+      if (1..gems.size).include?(result.to_i)
+        Gem::Specification.find_by_name name, gems[result.to_i - 1].version.version
+      else
+        error "Invalid option: #{result}"
+        nil
+      end
+    end
+
+    # Opens selected gem within default editor.
+    # ===== Parameters
+    # * +spec+ - Required. The gem specification.
+    def open_gem spec
+      `$EDITOR #{spec.full_gem_path}` if spec
+    end
+
+    # Opens selected gem within default browser.
+    # ===== Parameters
+    # * +spec+ - Required. The gem specification.
+    def read_gem spec
+      `open #{spec.homepage}` if spec
+    end
+
+    # Processes a gem for given name and command.
+    # ===== Parameters
+    # * +name+ - Required. The gem name.
+    # * +command+ - Required. The command to process the gem.
+    def process_gem name, command
+      specs = Gem::Specification.find_all_by_name name
+
+      case
+        when specs.size == 1
+          send "#{command}_gem", specs.first
+        when specs.size > 1
+          print_gems specs
+          send "#{command}_gem", pick_gem(specs, name)
+        else
+          say "Unable to find gem: #{name}"
+      end
+    end
+  end
+end