gemma 4.1.0 → 5.0.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YTE5M2Y0MmZjYTY1ODY2YTM5OGFkNjg1NmE0YWI0OGU0NTE4ZmViNA==
-  data.tar.gz: !binary |-
-    N2IxM2JiMzRkMzBhZWViMTU2MTJmODZmOWMwMWYwZGU0ZjBmMTFlOQ==
+SHA1:
+  metadata.gz: 50de89c768f1926c49fcf8710eb45a0828d92815
+  data.tar.gz: 3213328600aca48ce8c54c5a984d5548a844d3a9
 SHA512:
-  metadata.gz: !binary |-
-    Y2Y1NTE0YWYzZmY2MWVlMDI4MmE2MzBjMTg5YzQxYmViOTA3NjVhMzliNTll
-    MjNjZWY5MTA3NTYzZTQ4Y2U0MWFjNTE4ZmI0NzkxOGUyOTg4OTE2ODFiNzJm
-    NWNmZTYxZGU0OWRkYTQ1YjVlNWUzMDM3ZTJkYWNkZGQ4ZjJiNjM=
-  data.tar.gz: !binary |-
-    NGYyNDZjODdjMTVkMzNiN2Y4MDMwOTIwMTg0OTBjYWQ5ZWFlYjJkYzI5MjAw
-    Njg3Y2Y4MGQ2NTlhZTAxZTRmYzNmM2ZkOTQ5NDhjNGUyZTEwOGMwNjQ5YzIw
-    NTQxOWE2YWY2YjBlZWVmYzc2N2FiNTZlZGVmYTA1ODUwMDkyNmY=
+  metadata.gz: bb86aa15921e9ffd00b0441a087a726e97f5cd0cd77cf5fffdf55b0127f003ba46f1ae3dfd0703488bc223c11b2ce3adacc43899d9260a1d3bf2da0436cd7e5c
+  data.tar.gz: f04872a8b10b1ead1132381dbdd88e0b203bfd253015371a7b5b92bb9688cd451081f7fa8a76b9b3ef39e8b8c362b82bbfaf4d1651360b4eda1255327644900c

data/README.rdoc

@@ -38,13 +38,13 @@ This gives you a simple gem template like the following:
   |-- bin
   |   `-- my_gem           # executable (optional)
   |-- Gemfile              # for bundler (see below)
-  |-- lib                  
+  |-- lib
   |   |-- my_gem           # most of your code goes here
   |   |   `-- version.rb   # the version constant
   |   `-- my_gem.rb        # the main code file
   |-- my_gem.gemspec       # gem metadata
-  |-- Rakefile.rb          # development tasks
-  |-- README.rdoc          # documentation
+  |-- Rakefile             # development tasks
+  |-- README.md            # documentation
   `-- test                 # unit tests go here
       `-- my_gem
           `-- my_gem_test.rb
@@ -66,7 +66,7 @@ your gemspec; to enable them, add the following to the top of your +Rakefile+:
 
   Gemma::RakeTasks.with_gemspec_file 'my_gem.gemspec'
 
-  task :default => :test
+  task default: :test
 
 This gives you some standard rake tasks, in addition to any that you define
 yourself.
@@ -97,17 +97,10 @@ See the gemma API docs for more information.
 
 == INSTALLATION
 
-On RVM:
   gem install gemma
 
-On a system ruby:
-  sudo gem install bundler
-  sudo gem install gemma
-
 == DEVELOPMENT
 
-  gem install bundler
-  gem install gemma
   git clone git://github.com/jdleesmiller/gemma.git
   cd gemma
   bundle
@@ -130,6 +123,15 @@ On a system ruby:
 
 == HISTORY
 
+<em>5.0.0</em>
+* updated dependencies
+* added rubocop as a dependency and lint the code and the template
+* converted the template readme to markdown
+* dropped support for rubies < 2.3 (use 4.x for older rubies)
+
+<em>4.1.0</em>
+* updated dependencies
+
 <em>4.0.0</em>
 * updated dependencies
 * removed RunTasks -- bundler handles this now
@@ -152,7 +154,7 @@ On a system ruby:
 
 <em>1.0.0</em>
 * added templates
-* changed rdoc and yard tasks to use +require_paths+ instead of +files+ 
+* changed rdoc and yard tasks to use +require_paths+ instead of +files+
 * more tests
 * more documentation
 
@@ -184,4 +186,3 @@ 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/gemma

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 #
 # = gemma
 #
@@ -30,7 +31,7 @@
 #
 # --template=path::
 #   path to template to use instead of default template(s); specify this
-#   argument multiple times to copy from several templates (in order). 
+#   argument multiple times to copy from several templates (in order).
 #
 
 require 'getoptlong'
@@ -42,8 +43,8 @@ require 'highline'
 #
 
 getopt = GetoptLong.new(
-  ['--help',     '-h', GetoptLong::NO_ARGUMENT      ],
-  ['--version',  '-v', GetoptLong::NO_ARGUMENT      ],
+  ['--help',     '-h', GetoptLong::NO_ARGUMENT],
+  ['--version',  '-v', GetoptLong::NO_ARGUMENT],
   ['--name',           GetoptLong::REQUIRED_ARGUMENT],
   ['--dir',            GetoptLong::REQUIRED_ARGUMENT],
   ['--module',         GetoptLong::REQUIRED_ARGUMENT],
@@ -69,7 +70,7 @@ end
 
 # Remaining argument should be the command.
 command = ARGV.shift
-unless command && command == "new"
+unless command && command == 'new'
   Gemma::Utility.print_usage_from_file_comment __FILE__
   exit
 end
@@ -83,29 +84,31 @@ gt = Gemma::GemFromTemplate.new
 interactive = !opts['--name'] || opts['--name'].empty?
 
 if interactive
-  puts 
-  puts "creating a new gem with gemma..."
-  puts 
+  puts
+  puts 'creating a new gem with gemma...'
+  puts
 end
 
-unless interactive
-  gt.gem_name    = opts['--name']
+if interactive
+  gt.gem_name = hl.ask('gem name: ') { |q| q.validate = /^.+$/ } # weak
 else
-  gt.gem_name    = hl.ask('gem name: ') {|q| q.validate = /^.+$/} # weak
+  gt.gem_name = opts['--name']
 end
 
 if opts['--dir']
-  gt.dir_name    = opts['--dir']
+  gt.dir_name = opts['--dir']
 elsif interactive
-  gt.dir_name    =
-    hl.ask('create gem in directory: ') {|q| q.default = gt.dir_name}
+  gt.dir_name = hl.ask('create gem in directory: ') do |q|
+    q.default = gt.dir_name
+  end
 end
 
 if opts['--module']
   gt.module_name = opts['--module']
 elsif interactive
-  gt.module_name =
-    hl.ask('wrap contents in module called: ') {|q| q.default = gt.module_name}
+  gt.module_name = hl.ask('wrap contents in module called: ') do |q|
+    q.default = gt.module_name
+  end
 end
 
 templates = opts['--template']
@@ -113,7 +116,7 @@ if templates.empty?
   if interactive
     templates << 'base' << 'minitest'
     hl.choose do |menu|
-      menu.prompt = "type of gem: "
+      menu.prompt = 'type of gem: '
       menu.shell = true
       menu.choice('library (library scripts only)') do
         # no extras
@@ -123,12 +126,14 @@ if templates.empty?
       end
     end
   else
-    templates.push(*Gemma::GemFromTemplate::BUILTIN_TEMPLATES)
+    templates.concat(Gemma::GemFromTemplate::BUILTIN_TEMPLATES)
+  end
+  templates.map! do |name|
+    File.join(Gemma::GemFromTemplate::TEMPLATE_ROOT, name)
   end
-  templates.map!{|name| File.join(Gemma::GemFromTemplate::TEMPLATE_ROOT,name)}
 end
 
 puts "creating gem in #{gt.destination_path}"
 gt.create_gem(templates)
-puts "gem created; to get started, see the following TODO tags:"
+puts 'gem created; to get started, see the following TODO tags:'
 Gemma::Utility.rgrep(/TODO/, gt.destination_path)

data/lib/gemma.rb

@@ -1,17 +1,18 @@
+# frozen_string_literal: true
+require 'English'
 require 'shellwords'
 
-require 'gemma/version'
-require 'gemma/utility'
-require 'gemma/options'
-require 'gemma/rake_tasks'
+require_relative 'gemma/version'
+require_relative 'gemma/utility'
+require_relative 'gemma/options'
+require_relative 'gemma/rake_tasks'
 
 # Load default Rakefile plugins:
-require 'gemma/rake_tasks/plugin'
-require 'gemma/rake_tasks/rdoc_tasks'
-require 'gemma/rake_tasks/yard_tasks'
-require 'gemma/rake_tasks/minitest_tasks'
-require 'gemma/rake_tasks/gem_tasks'
-
-require 'gemma/conventions'
-require 'gemma/gem_from_template'
+require_relative 'gemma/rake_tasks/plugin'
+require_relative 'gemma/rake_tasks/rdoc_tasks'
+require_relative 'gemma/rake_tasks/yard_tasks'
+require_relative 'gemma/rake_tasks/minitest_tasks'
+require_relative 'gemma/rake_tasks/gem_tasks'
 
+require_relative 'gemma/conventions'
+require_relative 'gemma/gem_from_template'

data/lib/gemma/conventions.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
 module Gemma
   #
   # Methods to check input against accepted conventions.
   #
   # For help on extensions:
   # * http://nokogiri.org/tutorials/installing_nokogiri.html explains how to
-  # prepare several unices to build native extensions. 
+  # prepare several unices to build native extensions.
   #
   # General objectives for gemma:
   # * follow and promote accepted conventions where obvious
@@ -29,7 +30,7 @@ module Gemma
     #
     # @return [Boolean]
     #
-    def self.good_gem_name? gem_name
+    def self.good_gem_name?(gem_name)
       gem_name =~ /^[a-z0-9]+[a-z0-9_\-]*$/
     end
 
@@ -39,9 +40,8 @@ module Gemma
     #
     # @return [String]
     #
-    def self.gem_name_to_module_name gem_name
-      gem_name.gsub(/(?:^|_|-)([a-z0-9])/) { $1.upcase }
+    def self.gem_name_to_module_name(gem_name)
+      gem_name.gsub(/(?:^|_|-)([a-z0-9])/) { Regexp.last_match(1).upcase }
     end
   end
 end
-

data/lib/gemma/gem_from_template.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'erb'
 require 'fileutils'
 require 'yaml'
@@ -17,7 +18,7 @@ module Gemma
     # there are files that occur in multiple templates (files in earlier
     # templates are overwritten by those in later templates, at present).
     #
-    BUILTIN_TEMPLATES = %w(base executable minitest)
+    BUILTIN_TEMPLATES = %w(base executable minitest).freeze
 
     def initialize
       @gem_name = nil
@@ -39,7 +40,7 @@ module Gemma
     # @return [Boolean]
     #
     def good_gem_name?
-      Conventions.good_gem_name? self.gem_name
+      Conventions.good_gem_name? gem_name
     end
 
     #
@@ -49,7 +50,7 @@ module Gemma
     # @return [String]
     #
     def module_name
-      @module_name || Conventions.gem_name_to_module_name(self.gem_name)
+      @module_name || Conventions.gem_name_to_module_name(gem_name)
     end
 
     #
@@ -72,10 +73,10 @@ module Gemma
     attr_writer :dir_name
 
     #
-    # Full path of root of the gem to be created. 
+    # Full path of root of the gem to be created.
     #
     def destination_path
-      File.expand_path(File.join('.',self.dir_name))
+      File.expand_path(File.join('.', dir_name))
     end
 
     #
@@ -84,25 +85,26 @@ module Gemma
     # @param [Array<String>] template_paths absolute paths of the template
     #        directories to copy
     #
-    def create_gem template_paths, destination_path=self.destination_path
-      raise "destination #{destination_path} exists" if File.exists?(
-        destination_path)
+    def create_gem(template_paths, destination_path = self.destination_path)
+      if File.exist?(destination_path)
+        raise "destination #{destination_path} exists"
+      end
 
       # Copy templates in.
       FileUtils.mkdir_p destination_path
-      for path in template_paths
-        FileUtils.cp_r File.join(path,'.'), destination_path
+      template_paths.each do |path|
+        FileUtils.cp_r File.join(path, '.'), destination_path
       end
 
       Dir.chdir destination_path do
-        dirs = Dir["**/*"].select { |f| File.directory? f }.sort
+        dirs = Dir['**/*'].select { |f| File.directory? f }.sort
         dirs.grep(/gem_name/).each do |file|
           FileUtils.mv file, file.gsub(/gem_name/, gem_name)
         end
 
-        files = (Dir["**/*"] + Dir["**/.*"]).select { |f| File.file? f }.sort
-        FileUtils.chmod 0644, files
-        FileUtils.chmod 0755, files.select{|f| File.dirname(f) == 'bin'}
+        files = (Dir['**/*'] + Dir['**/.*']).select { |f| File.file? f }.sort
+        FileUtils.chmod 0o644, files
+        FileUtils.chmod 0o755, files.select { |f| File.dirname(f) == 'bin' }
         files.each do |file|
           # Rename files with names that depend on the gem name.
           if file =~ /gem_name/
@@ -112,15 +114,14 @@ module Gemma
           end
 
           # Run erb to customize each file.
-          if File.extname(file) == ".erb"
-            erb_file = File.read file
-            File.open file, "w" do |f|
-              erb = ERB.new(erb_file)
-              erb.filename = file
-              f.puts erb.result(binding)
-            end
-            FileUtils.mv file, file.sub(/\.erb$/, '')
+          next unless File.extname(file) == '.erb'
+          erb_file = File.read file
+          File.open file, 'w' do |f|
+            erb = ERB.new(erb_file)
+            erb.filename = file
+            f.puts erb.result(binding)
           end
+          FileUtils.mv file, file.sub(/\.erb$/, '')
         end
       end
     end

data/lib/gemma/options.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Gemma
   #
   # Helpers for processing command line arguments.
@@ -35,7 +36,7 @@ module Gemma
     #
     # The +options+ parameter takes an array of arguments; to split a string
     # into the appropriate form, you can use the +Shellwords+ module in the ruby
-    # standard library.  
+    # standard library.
     #
     # @example
     #   Gemma::Options.extract(%w(-a), %w(-a foo bar.txt))
@@ -52,42 +53,45 @@ module Gemma
     # @return [ExtractResult] contains the argument for the given option and the
     #         rest of the options
     #
-    def self.extract names, options
+    def self.extract(names, options)
       options = options.dup
       result = nil
       done = []
 
       until options.empty?
         x = options.shift
-        if x == '--' then
+        if x == '--'
           # Stop at the '--' terminator.
           done << x
           break
-        elsif x =~ /^(--[^=]+)/ then
-          if names.member?($1) then
+        elsif x =~ /^(--[^=]+)/
+          if names.member?(Regexp.last_match(1))
             # Found a long style option; look for its argument (if any).
-            if x =~ /=(.*)$/ then
-              result = $1
-            elsif !options.empty? && options.first !~ /^-./
-              result = options.shift
-            else
-              result = ''
-            end
+            result = \
+              if x =~ /=(.*)$/
+                Regexp.last_match(1)
+              elsif !options.empty? && options.first !~ /^-./
+                options.shift
+              else
+                ''
+              end
           else
             done << x
           end
-        elsif x =~ /^(-(.))(.*)/ then
+        elsif x =~ /^(-(.))(.*)/
           # Found a short style option; this may actually represent several
           # options; look for matching short options.
-          name, letter, rest = $1, $2, $3
+          name = Regexp.last_match(1)
+          rest = Regexp.last_match(3)
           if names.member?(name)
-            if rest.length > 0
-              result = rest
-            elsif !options.empty? && options.first !~ /^-./
-              result = options.shift
-            else
-              result = ''
-            end
+            result = \
+              if rest.length.positive?
+                rest
+              elsif !options.empty? && options.first !~ /^-./
+                options.shift
+              else
+                ''
+              end
           else
             done << x
           end
@@ -101,4 +105,3 @@ module Gemma
     end
   end
 end
-

data/lib/gemma/rake_tasks.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rake/clean'
 
 module Gemma
@@ -16,10 +17,9 @@ module Gemma
   #   # ... other tasks ...
   #
   class RakeTasks
-
     # Alias for new.
     class <<self
-      alias :with_gemspec_file :new
+      alias with_gemspec_file new
     end
 
     #
@@ -35,11 +35,11 @@ module Gemma
     #
     # @private
     #
-    def initialize gemspec, &block
+    def initialize(gemspec)
       # Load gemspec.
       if gemspec.is_a?(String)
         @gemspec_file_name = gemspec
-        @gemspec = Gem::Specification::load(gemspec_file_name)
+        @gemspec = Gem::Specification.load(gemspec_file_name)
       elsif gemspec.is_a?(Gem::Specification)
         @gemspec_file_name = nil
         @gemspec = gemspec
@@ -51,13 +51,13 @@ module Gemma
       create_default_plugins
 
       # Let the user add more plugins and alter settings.
-      block.call(self) if block_given?
+      yield(self) if block_given?
 
       @plugins.values.each do |plugin|
         begin
           plugin.create_rake_tasks
         rescue
-          warn "plugin #{plugin.class} failed: #{$!}"
+          warn "plugin #{plugin.class} failed: #{$ERROR_INFO}"
         end
       end
     end
@@ -86,22 +86,30 @@ module Gemma
     #
     # @return [RDocTasks]
     #
-    def rdoc; @plugins[:rdoc] end
+    def rdoc
+      @plugins[:rdoc]
+    end
 
     #
     # @return [MinitestTasks]
     #
-    def test; @plugins[:test] end
+    def test
+      @plugins[:test]
+    end
 
     #
     # @return [YardTasks]
     #
-    def yard; @plugins[:yard] end
+    def yard
+      @plugins[:yard]
+    end
 
     #
     # @return [GemTasks]
     #
-    def gem; @plugins[:gem] end
+    def gem
+      @plugins[:gem]
+    end
 
     protected
 
@@ -109,7 +117,8 @@ module Gemma
       @plugins[:rdoc] = Gemma::RakeTasks::RDocTasks.new(gemspec)
       @plugins[:test] = Gemma::RakeTasks::MinitestTasks.new(gemspec)
       @plugins[:yard] = Gemma::RakeTasks::YardTasks.new(gemspec)
-      @plugins[:gem] = Gemma::RakeTasks::GemTasks.new(gemspec,gemspec_file_name)
+      @plugins[:gem] =
+        Gemma::RakeTasks::GemTasks.new(gemspec, gemspec_file_name)
     end
   end
 end