gemma 4.1.0 → 5.0.0

data/lib/gemma/rake_tasks/gem_tasks.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Gemma
   class RakeTasks
     #
@@ -13,7 +14,7 @@ module Gemma
       # @param [Gem::Specification] gemspec
       # @param [String, nil] gemspec_file_name
       #
-      def initialize gemspec, gemspec_file_name
+      def initialize(gemspec, gemspec_file_name)
         super(gemspec)
         @gemspec_file_name = gemspec_file_name
       end
@@ -28,11 +29,10 @@ module Gemma
       def create_rake_tasks
         require 'bundler/gem_helper'
         dir = File.dirname(@gemspec_file_name) if @gemspec_file_name
-        Bundler::GemHelper.install_tasks(:dir => dir,
-                                         :name => gemspec.name)
+        Bundler::GemHelper.install_tasks(dir: dir,
+                                         name: gemspec.name)
         nil
       end
     end
   end
 end
-

data/lib/gemma/rake_tasks/minitest_tasks.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Gemma
   class RakeTasks
     #
@@ -5,18 +6,18 @@ module Gemma
     # the gemspec and the gem's +test+ directory are placed on the load path,
     # and the +test_files+ given in the gemspec are executed as tests.
     #
-    # Minitest works on both 1.8 and 1.9, and it's mostly compatible with 
+    # Minitest works on both 1.8 and 1.9, and it's mostly compatible with
     # <tt>Test::Unit</tt> tests.
     #
     # This plugin is based on the `Rake::TestTask` that comes bundled with rake.
     # If you need an option that isn't exposed by the plugin, you can modify the
-    # `TestTask` object directly in a block passed to {#with_test_task}. 
+    # `TestTask` object directly in a block passed to {#with_test_task}.
     #
     class MinitestTasks < Plugin
       #
       # @param [Gem::Specification] gemspec
       #
-      def initialize gemspec
+      def initialize(gemspec)
         super(gemspec)
 
         # Defaults.
@@ -28,15 +29,15 @@ module Gemma
       #
       # Name of rake task used to run the test; defaults to test.
       #
-      # @return [Symbol]    
-      # 
+      # @return [Symbol]
+      #
       attr_accessor :task_name
 
       #
       # The files to test; defaults to the +test_files+ from the gemspec.
       #
-      # @return [Array<String>]    
-      # 
+      # @return [Array<String>]
+      #
       attr_accessor :files
 
       #
@@ -49,7 +50,7 @@ module Gemma
       #
       # @return [nil]
       #
-      def with_test_task &block
+      def with_test_task(&block)
         @with_test_task = block
         nil
       end
@@ -62,13 +63,13 @@ module Gemma
       # @private
       #
       def create_rake_tasks
-        unless self.files.empty?
+        unless files.empty?
           require 'rake/testtask'
-          Rake::TestTask.new(self.task_name) do |tt|
-            tt.libs        = gemspec.require_paths.dup
-            tt.libs       << 'test'
-            tt.test_files  = self.files
-            tt.ruby_opts  << '-rubygems' << '-rbundler/setup'
+          Rake::TestTask.new(task_name) do |tt|
+            tt.libs = gemspec.require_paths.dup
+            tt.libs << 'test'
+            tt.test_files = files
+            tt.ruby_opts << '-rubygems' << '-rbundler/setup'
             @with_test_task.call(tt) if @with_test_task
           end
         end
@@ -77,4 +78,3 @@ module Gemma
     end
   end
 end
-

data/lib/gemma/rake_tasks/plugin.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 module Gemma
   class RakeTasks
-    # 
+    #
     # Plugins generate rake tasks based on the content of the gemspec.
     #
     # The intention is that the plugin processes the gemspec and sets
@@ -13,7 +14,7 @@ module Gemma
     class Plugin
       include Rake::DSL
 
-      def initialize gemspec
+      def initialize(gemspec)
         @gemspec = gemspec
       end
 

data/lib/gemma/rake_tasks/rdoc_tasks.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rdoc/task'
 
 module Gemma
@@ -7,18 +8,18 @@ module Gemma
     # the gemspec.
     #
     # The default settings are based on the +require_paths+, +rdoc_options+ and
-    # +extra_rdoc_files+ data in the gemspec. 
+    # +extra_rdoc_files+ data in the gemspec.
     #
     # This plugin is based on the <tt>Rake::RDocTask</tt> that comes bundled
     # with rdoc.  If you need an option that isn't exposed by the plugin, you
     # can modify the +RDocTask+ object directly in a block passed to
-    # {#with_rdoc_task}. 
+    # {#with_rdoc_task}.
     #
     class RDocTasks < Plugin
       #
       # @param [Gem::Specification] gemspec
       #
-      def initialize gemspec
+      def initialize(gemspec)
         super(gemspec)
 
         # Defaults.
@@ -42,15 +43,15 @@ module Gemma
       #
       # Name of rake task used to generate these docs; defaults to rdoc.
       #
-      # @return [Symbol]    
-      # 
+      # @return [Symbol]
+      #
       attr_accessor :task_name
 
       #
       # Name of output directory (the rdoc option --output); extracted from
       # gemspec; defaults to rdoc.
       #
-      # @return [String] 
+      # @return [String]
       #
       attr_accessor :output
 
@@ -58,7 +59,7 @@ module Gemma
       # Name of file to display in index.html (the rdoc option --main);
       # extracted from gemspec; defaults to nil (none).
       #
-      # @return [String, nil] 
+      # @return [String, nil]
       #
       attr_accessor :main
 
@@ -66,7 +67,7 @@ module Gemma
       # Title for HTML output (the rdoc option --title); extracted from gemspec;
       # defaults to nil (unspecified).
       #
-      # @return [String, nil] 
+      # @return [String, nil]
       #
       attr_accessor :title
 
@@ -74,7 +75,7 @@ module Gemma
       # Name of template used to generate html output (the rdoc option
       # --template); extracted from gemspec; defaults to nil (unspecified).
       #
-      # @return [String, nil] 
+      # @return [String, nil]
       #
       attr_accessor :template
 
@@ -82,7 +83,7 @@ module Gemma
       # Files and directories to be processed by rdoc; extracted from gemspec;
       # by default, these are the gem's +require_paths+ and +extra_rdoc_files+.
       #
-      # @return [Array<String>] 
+      # @return [Array<String>]
       #
       attr_accessor :files
 
@@ -91,7 +92,7 @@ module Gemma
       # the {#output}, {#main}, {#title} and {#template} options and the
       # {#files} list are handled separately.
       #
-      # @return [Array<String>] 
+      # @return [Array<String>]
       #
       attr_accessor :options
 
@@ -105,7 +106,7 @@ module Gemma
       #
       # @return [nil]
       #
-      def with_rdoc_task &block
+      def with_rdoc_task(&block)
         @with_rdoc_task = block
         nil
       end
@@ -118,16 +119,16 @@ module Gemma
       # @private
       #
       def create_rake_tasks
-        Rake::RDocTask.new(self.task_name) do |rd|
-          rd.rdoc_dir      = self.output
-          rd.rdoc_files    = self.files
-          rd.title         = self.title
-          rd.main          = self.main
-          rd.template      = self.template
-          rd.options       = self.options
+        Rake::RDocTask.new(task_name) do |rd|
+          rd.rdoc_dir      = output
+          rd.rdoc_files    = files
+          rd.title         = title
+          rd.main          = main
+          rd.template      = template
+          rd.options       = options
           @with_rdoc_task.call(rd) if @with_rdoc_task
         end
-        CLOBBER.include(self.output)
+        CLOBBER.include(output)
 
         nil
       end

data/lib/gemma/rake_tasks/yard_tasks.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'yard'
 
 module Gemma
@@ -24,13 +25,13 @@ module Gemma
     # This plugin is based on the <tt>YARD::Rake::YardocTask</tt> that comes
     # bundled with yard.  If you need an option that isn't exposed by the
     # plugin, you can modify the +YardocTask+ object directly in a block passed
-    # to {#with_yardoc_task}. 
+    # to {#with_yardoc_task}.
     #
     class YardTasks < Plugin
       #
       # @param [Gem::Specification] gemspec
       #
-      def initialize gemspec
+      def initialize(gemspec)
         super(gemspec)
 
         # Defaults.
@@ -55,14 +56,14 @@ module Gemma
       #
       # Name of rake task used to generate these docs; defaults to yard.
       #
-      # @return [Symbol] 
+      # @return [Symbol]
       #
       attr_accessor :task_name
 
       #
       # Name of output directory (the yard option --output); defaults to yard.
       #
-      # @return [String] 
+      # @return [String]
       #
       attr_accessor :output
 
@@ -70,7 +71,7 @@ module Gemma
       # Name of file to display in index.html (the yard option --main);
       # extracted from gemspec; defaults to nil (none).
       #
-      # @return [String, nil] 
+      # @return [String, nil]
       #
       attr_accessor :main
 
@@ -78,7 +79,7 @@ module Gemma
       # Title for HTML output (the yard option --title); extracted from gemspec;
       # defaults to nil (unspecified).
       #
-      # @return [String, nil] 
+      # @return [String, nil]
       #
       attr_accessor :title
 
@@ -86,7 +87,7 @@ module Gemma
       # Ruby files to be processed by yard; these are extracted from the
       # gemspec; by default these are the +require_paths+.
       #
-      # @return [Array<String>] 
+      # @return [Array<String>]
       #
       attr_accessor :files
 
@@ -94,7 +95,7 @@ module Gemma
       # Extra files (e.g. FAQ, LICENSE) to be processed by yard; these are
       # extracted from the gemspec.
       #
-      # @return [Array<String>] 
+      # @return [Array<String>]
       #
       attr_accessor :extra_files
 
@@ -117,7 +118,7 @@ module Gemma
       #
       # @return [nil]
       #
-      def with_yardoc_task &block
+      def with_yardoc_task(&block)
         @with_yardoc_task = block
         nil
       end
@@ -131,32 +132,32 @@ module Gemma
       #
       def create_rake_tasks
         YARD::Rake::YardocTask.new do |yd|
-          yd.name    = self.task_name
+          yd.name    = task_name
           yd.options = complete_options
-          yd.files   = self.files
-          yd.files.push('-', *self.extra_files) unless self.extra_files.empty?
+          yd.files   = files
+          yd.files.push('-', *extra_files) unless extra_files.empty?
           @with_yardoc_task.call(yd) if @with_yardoc_task
         end
-        CLOBBER.include(self.output)
+        CLOBBER.include(output)
         CLOBBER.include('.yardoc')
         nil
       rescue LoadError
-        # Assume yard is not installed.
+        nil # Assume yard is not installed.
       end
 
-      private 
+      private
 
-      # 
+      #
       # Options to be passed to yardoc; this includes {#options} and the
       # {#main}, {#title} and {#output} options.
       #
       # @return [Array<String>]
-      # 
+      #
       def complete_options
-        opts = self.options.dup
-        opts.push('--main', self.main) if self.main
-        opts.push('--title', self.title) if self.title
-        opts.push('--output', self.output)
+        opts = options.dup
+        opts.push('--main', main) if main
+        opts.push('--title', title) if title
+        opts.push('--output', output)
         opts
       end
     end

data/lib/gemma/utility.rb

@@ -1,17 +1,23 @@
+# frozen_string_literal: true
 module Gemma
+  #
+  # Utility functions.
+  #
   module Utility
-    # 
+    #
     # If the usage information for a script is documented in a comment block at
     # the top of the file, this method prints it out. If there is a shebang
     # (#!) on the first line, it is not printed.
     #
-    def self.print_usage_from_file_comment file, comment_char='#', io=$stdout
+    def self.print_usage_from_file_comment(
+      file, comment_char = '#', io = $stdout
+    )
       lines = File.readlines(file)
       lines.shift if lines.first =~ /^#!/ # ignore shebang
-      for line in lines
+      lines.each do |line|
         line.strip!
         break unless line =~ /^#{comment_char}(.*)/
-        io.puts $1
+        io.puts Regexp.last_match(1)
       end
     end
 
@@ -26,9 +32,10 @@ module Gemma
     #
     # @return [nil]
     #
-    def self.rgrep tag, path, io=$stdout
+    def self.rgrep(tag, path, io = $stdout)
       Dir.chdir path do
-        (Dir["**/*"] + Dir["**/.*"]).select {|f| File.file? f}.sort.each do |f|
+        globs = Dir['**/*'] + Dir['**/.*']
+        globs.select { |f| File.file?(f) }.sort.each do |f|
           File.readlines(f).each_with_index do |line, i|
             io.puts "#{f}:#{i}: #{line}" if line =~ tag
           end
@@ -38,4 +45,3 @@ module Gemma
     end
   end
 end
-

data/lib/gemma/version.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 module Gemma
-  VERSION_MAJOR = 4
-  VERSION_MINOR = 1
+  VERSION_MAJOR = 5
+  VERSION_MINOR = 0
   VERSION_PATCH = 0
   VERSION = [VERSION_MAJOR, VERSION_MINOR, VERSION_PATCH].join('.')
 end

data/template/base/.rubocop.yml.erb

@@ -0,0 +1,6 @@
+AllCops:
+  TargetRubyVersion: <%= RbConfig::CONFIG['MAJOR'] %>.<%= RbConfig::CONFIG['MINOR'] %>
+
+Style/Documentation:
+  Exclude:
+    - 'test/**/*'

data/template/base/Gemfile

@@ -1,3 +1,4 @@
-source "http://rubygems.org" 
-gemspec
+# frozen_string_literal: true
 
+source 'https://rubygems.org'
+gemspec

data/template/base/{README.rdoc.erb → README.md.erb}

@@ -1,28 +1,32 @@
-= <%= gem_name %>
+# <%= gem_name %>
 
 * TODO url
 
-== SYNOPSIS
+## Synopsis
 
 TODO description
 
-=== Usage
+### Usage
 
-  TODO (code sample of usage)
+```ruby
+TODO (code sample of usage)
+```
 
-== REQUIREMENTS
+## Requirements
 
 * TODO (list of requirements)
 
-== INSTALLATION
+## Installation
 
-  sudo gem install <%= gem_name %>
+```
+gem install <%= gem_name %>
+```
 
-== DEVELOPMENT
+## Development
 
 TODO developer advice
 
-== LICENSE
+## License
 
 (The MIT License)
 
@@ -46,4 +50,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.
-