rake_tasks 2.0.6 → 3.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ebdca6dc2cdf0c36add2a79641777a56ada03bac
+  data.tar.gz: 293c0d0f25ef09b92ce62f9afa77afdb4beb4b8e
+SHA512:
+  metadata.gz: 8c72429dac0483323866f90b62d46f59807181566a8ff0905910474ec6f65d45e625c778e6a2925c92705b49fd359b9a068777d25fbf572ae61720973b886149
+  data.tar.gz: b96079c97a75e99e1ca5d0e202df1c2e2814672c44f813f096b31c072681b15b919e6da836a43a6e59e28395203c82f6f01d4c7b30a4ae95cfc8ec56e3575aa6

data.tar.gz.sig

@@ -0,0 +1,3 @@
+��o*
+ �`��1�k�!���S��
��\��D�|�xJ��拖=��o�
+�^�����!.�CX4�Hݩv��đ���9���.`/������s3��@���'6í�:K�W�Z�@[ci����-�53�(�lΟC���4��QŎR����7�a�?��|

data/Gemfile

@@ -1,3 +1,5 @@
-source "http://rubygems.org"
-
-gemspec
+source 'http://rubygems.org'
+
+gemspec
+
+#gem 'faker', path: '~/source/forks/faker'

data/lib/base/util.rb

@@ -0,0 +1,39 @@
+class Util
+  def self.dir_glob(*patterns)
+    Dir.glob(*patterns)
+  end
+
+  def self.open_file(*args, &block)
+    File.open(*args, &block)
+  end
+
+  def self.write_file(file_path, array)
+    open_file(file_path, 'w') do |file|
+      array.each do |element|
+        file.puts element
+      end
+    end
+  end
+
+  def self.file?(*args)
+    File.file?(*args)
+  end
+
+  def self.directory?(*args)
+    File.directory?(*args)
+  end
+
+  def self.rm(*args)
+    FileUtils.rm(*args)
+  end
+
+  def self.load_yaml(*args)
+    # Psych must be available on the system,
+    # preferably via installing ruby with libyaml already installed.
+    Psych.load_file(*args)
+  end
+
+  def self.load_gemspec(*args)
+    Gem::Specification.load(*args)
+  end
+end

data/lib/rake_tasks.rb

@@ -28,9 +28,6 @@
 ################################################################################
 #++
 
-require 'rake/testtask'
-require 'rdoc/task'
-require 'rake/clean'
 require 'fileutils'
 require 'psych'
 
@@ -38,36 +35,26 @@ module RakeTasks
   # Contains the full path to the shell script to run tests in other env's.
   SCRIPTS = {
     :rubies  => File.expand_path(File.join(
-      File.dirname(__FILE__), 'rake_tasks', 'lib', 'rubies.sh')),
+      File.dirname(__FILE__), '..', 'scripts', 'rubies.sh')),
     :gemsets => File.expand_path(File.join(
-      File.dirname(__FILE__), 'rake_tasks', 'lib', 'bundle_install.sh')),
+      File.dirname(__FILE__), '..', 'scripts', 'bundle_install.sh')),
   }
 end
 
 gem_name = File.basename(__FILE__, '.rb')
+base_path = File.dirname(__FILE__)
 
-task :default
+# Require base files.
+Dir[File.join(base_path, 'base', '*.rb')].each do |base|
+  require base
+end
 
-# Require lib files.
-Dir[File.join(File.dirname(__FILE__), gem_name, 'lib', '*.rb')].each do |lib|
+# Require files.
+Dir[File.join(base_path, gem_name, '*.rb')].each do |lib|
   require lib
 end
 
-# Require tasks.
-# These must be required in this order as
-# there is an order of precedence for the default task.
-# Using a glob, they were being required in different orders
-# in different situations.
-# Specifically, it was different depending on whether it was
-# consumed as an installed gem or pointing to the source.
-base = File.dirname(__FILE__)
-
-require File.join(base, 'rake_tasks/rdoc')
-require File.join(base, 'rake_tasks/doc')
-require File.join(base, 'rake_tasks/gem')
-require File.join(base, 'rake_tasks/test')
-
-# Include any ruby files in the tasks folder.
-Dir[File.join(Dir.getwd, 'tasks', '*.rb')].each do |rake_file|
-  require rake_file
+# Include any rake files in tasks folders.
+Dir[File.join(Dir.getwd, '**', 'tasks', '**', '*.rake')].each do |rake_file|
+  import rake_file
 end

data/lib/rake_tasks/doc.rb

@@ -1,3 +1,5 @@
+# This file holds the class that handles documentation utilities.
+
 #--
 ################################################################################
 #                      Copyright (C) 2011 Travis Herrick                       #
@@ -28,35 +30,81 @@
 ################################################################################
 #++
 
-if RakeTasks::Gem.gem_file?
-  ############################################################################
-  namespace :doc do
-  ############################################################################
+# The main module for this gem.
+module RakeTasks
+  # This class will handle documentation utilities.
+  class Doc
+    # Constructor.
+    def initialize(gem_info = RakeTasks::Gem)
+      @gem_spec = gem_info.gem_spec
+      @gem_title = gem_info.gem_title(@gem_spec)
+      @license_path = 'license'
+      @contents = nil
+    end
 
-    gem_spec_file = RakeTasks::Gem.gem_spec_file
+    # The default contents for a readme file.
+    def readme_contents
+      gem_title = @gem_title
+      gem_spec = @gem_spec
 
-    readme = 'README.md'
-    readme = 'README_GENERATED.md' if File.file?(readme)
+      @contents ||= %Q{
+#{header :h1, "Welcome to #{gem_title}"}
 
-    file readme => gem_spec_file do |t|
-      doc_obj = RakeTasks::Doc.new
+#{gem_spec.description}
 
-      File.open(readme, 'w') do |file|
-        file.puts doc_obj.readme_contents
-      end
+#{header :h2, 'Getting Started'}
+
+Install #{gem_title} at the command prompt if you haven't yet:
+
+    $ gem install #{gem_spec.name}
+
+Require the gem in your Gemfile:
+
+    gem '#{gem_spec.name}', '~> #{gem_spec.version}'
+
+Require the gem wherever you need to use it:
+
+    require '#{gem_spec.name}'
+
+#{header :h2, 'Usage'}
+
+TODO
+
+#{header :h2, 'Additional Notes'}
+
+TODO
+
+#{header :h2, 'Additional Documentation'}
+
+    $ rake rdoc:app
+#{license_details}}.strip
+
+      return @contents.split("\n")
     end
 
-    desc "Generate a #{readme} file."
-    task :readme => readme
+    ########################################################################
+    private
+    ########################################################################
 
-    desc "Removes files associated with generating documentation."
-    task :clobber do |t|
-      rm_f readme
+    # Returns formatted headers.
+    def header(type, text = nil)
+      case type
+      when :h1
+        "#{text}\n#{'=' * text.length}"
+      when :h2
+        "#{text}\n#{'-' * text.length}"
+      end
     end
 
-  ############################################################################
-  end # :doc
-  ############################################################################
+    # Compose the license details.
+    def license_details
+      return if @gem_spec.licenses.empty?
 
-  task :clobber => 'doc:clobber'
+      %Q{
+#{header :h2, 'License'}
+
+#{@gem_title} is released under the #{@gem_spec.licenses.first} license.
+}
+    end
+  end
 end

data/lib/rake_tasks/gem.rb

@@ -1,3 +1,5 @@
+# This file holds the class that handles gem utilities.
+
 #--
 ################################################################################
 #                      Copyright (C) 2011 Travis Herrick                       #
@@ -28,52 +30,84 @@
 ################################################################################
 #++
 
-if RakeTasks::Gem.gem_file?
-  ############################################################################
-  namespace :gem do
-  ############################################################################
+# The main module for this gem.
+module RakeTasks
+  # This class will handle gem utilities.
+  class Gem
+    class << self
+      # Check whether a gem spec file exists for this project.
+      def gemspec_file?
+        return !gem_spec_file.nil?
+      end
 
-    gem_spec = RakeTasks::Gem.gem_spec
-    gem_spec_file = RakeTasks::Gem.gem_spec_file
+      def gem_file?
+        return !gem_file.nil?
+      end
 
-    file gem_spec.file_name =>
-        [gem_spec_file, *Dir['lib/**/*.rb'], 'Gemfile', 'Gemfile.lock'] do |t|
-      puts `gem build #{gem_spec_file}`
-    end
+      # Returns the gem title.
+      # This is the gem name with underscores removed.
+      # Wherever an underscore is removed, the next letter is capitalized.
+      def gem_title(spec = gem_spec)
+        return nil unless spec.respond_to?(:name)
+        spec.name.split('_').map { |w| w.capitalize }.join('')
+      end
 
-    desc "Build #{gem_spec.name} gem version #{gem_spec.version}."
-    task :build => gem_spec.file_name
+      # Get the gem specification.
+      def gem_spec
+        Util.load_gemspec(gem_spec_file) if gemspec_file?
+      end
 
-    desc "Install the #{gem_spec.name} gem."
-    task :install => [gem_spec.file_name] do |t|
-      puts `gem install #{gem_spec.file_name} --no-rdoc --no-ri`
-    end
+      # Check for a gem spec file.
+      def gem_spec_file
+        Util.dir_glob('*.gemspec').first
+      end
 
-    desc "Removes files associated with building and installing #{gem_spec.name}."
-    task :clobber do |t|
-      rm_f gem_spec.file_name
-    end
+      def gem_file
+        @gem_file ||= Util.dir_glob('*.gem').first
+      end
+
+      # Returns the name and version from the specified gem specification.
+      def version(spec = gem_spec)
+        if spec.respond_to?(:name) && spec.respond_to?(:version)
+          "#{spec.name} version #{spec.version}"
+        end
+      end
+
+      # Updates the version in the gem specification file.
+      def version!(value, spec = gem_spec)
+        return unless gem_spec_file
 
-    desc "Removes the gem file, builds, and installs."
-    task :generate => ['gem:clobber', gem_spec.file_name, 'gem:install']
+        temp = StringIO.new
+        write_temp spec, temp, gem_spec_file, value
 
-    desc "Show/Set the version number."
-    task :version, [:number] do |t, args|
-      if args[:number].nil?
-        puts RakeTasks::Gem.version(gem_spec)
-      else
-        RakeTasks::Gem.version! args[:number], gem_spec
-        gem_spec = RakeTasks::Gem.gem_spec
-        puts RakeTasks::Gem.version(gem_spec)
+        temp.rewind
+        write_file gem_spec_file, temp
       end
-    end
 
-  ############################################################################
-  end # :gem
-  ############################################################################
+      private
 
-  Rake::Task[:default].prerequisites.clear
-  task :default => 'gem:build'
+      # Write the contents of a stream to a file.
+      def write_file(gem_spec_file, stream)
+        Util.open_file(gem_spec_file, 'w') do |file|
+          while line = stream.gets
+            file.puts line
+          end
+        end
+      end
 
-  task :clobber => 'gem:clobber'
+      # Write the contents of a file to an in-memory stream object,
+      # changing the version.
+      def write_temp(spec, stream, gem_spec_file, version)
+        Util.open_file(gem_spec_file, 'r') do |file|
+          while line = file.gets
+            if line =~ /version *= *['"]#{spec.version}['"]/
+              stream.puts line.sub(/['"].*['"]/, "'#{version}'")
+            else
+              stream.puts line
+            end
+          end
+        end
+      end
+    end
+  end
 end

data/lib/rake_tasks/{lib/parser.rb → parser.rb}

@@ -36,7 +36,13 @@ module RakeTasks
   # This class will handle parsing duties.
   class Parser
     def initialize
-      @data = []
+      @data = {
+        tests:      0,
+        assertions: 0,
+        failures:   0,
+        errors:     0,
+        skips:      0,
+      }
     end
 
     # Parse a given line.
@@ -48,28 +54,21 @@ module RakeTasks
           puts line.strip #unless line.strip.empty?
         when /^\d+ tests, \d+ assertions, /
           puts line.strip
-          @data << line.split(', ').map { |x| x.to_i }
+
+          data = line.split(', ').map { |x| x.to_i }
+
+          @data[:tests]      += data[0]
+          @data[:assertions] += data[1]
+          @data[:failures]   += data[2]
+          @data[:errors]     += data[3]
+          @data[:skips]      += data[4]
       end
     end
 
     # Calculate the summary and send it to standard out.
     def summarize
-      tests      = 0
-      assertions = 0
-      failures   = 0
-      errors     = 0
-      skips      = 0
-
-      @data.each do |status|
-        tests      = tests      + status[0]
-        assertions = assertions + status[1]
-        failures   = failures   + status[2]
-        errors     = errors     + status[3]
-        skips      = skips      + status[4]
-      end
-
-      puts "%d tests, %d assertions, %d failures, %d errors, %d skips" % [
-        tests, assertions, failures, errors, skips]
+      puts "%d tests, %d assertions, %d failures, %d errors, %d skips" %
+        @data.values
     end
   end
 end

data/lib/rake_tasks/tasks/cane.rb

@@ -0,0 +1,27 @@
+require 'cane'
+require 'cane/rake_task'
+
+namespace :cane do
+  desc ''
+  Cane::RakeTask.new(:quality) do |cane|
+    cane.canefile = '.cane'
+  end
+
+  desc 'Check abc metrics with cane'
+  Cane::RakeTask.new(:warn) do |cane|
+    cane.canefile = '.cane'
+    cane.abc_max  = 7
+    cane.no_doc   = true
+    cane.no_style = true
+  end
+
+  desc 'Check code quality metrics with cane for all files'
+  Cane::RakeTask.new(:all) do |cane|
+    cane.canefile = '.cane'
+    cane.style_exclude = []
+    cane.abc_exclude = []
+  end
+end
+
+desc 'Run cane to check quality metrics'
+task :cane => 'cane:quality'

data/lib/rake_tasks/tasks/checksum.rb

@@ -0,0 +1,19 @@
+if RakeTasks::Gem.gem_file?
+  require 'digest/sha2'
+
+  desc 'Generate a checksum for the current gem file'
+  task :checksum do |task|
+    gem_file = RakeTasks::Gem.gem_file
+    checksum = Digest::SHA512.new.hexdigest(File.read(gem_file))
+    checksum_file = File.basename(gem_file)
+    checksum_path = "checksum/#{checksum_file}.sha512"
+
+    puts checksum
+
+    FileUtils.mkdir_p 'checksum' unless File.directory?('checksum')
+
+    File.open(checksum_path, 'w') do |file|
+      file.write checksum
+    end
+  end
+end