corundum 0.4.1 → 0.5.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MDYzZGYwYjJmYjc5NzM3YmVkZmZiOTkyZWNhMjY0NTAzMjE2ZDVhZg==
+    YjUwMDk0ZDAyYzk4MzQ5OTk1MDg2Y2ZmMTgxMTkwNTIyYjg1YTFjNw==
   data.tar.gz: !binary |-
-    Y2IwMTI1YTkwYWVmMTQ4MjYwYjBiMGI2ZjM5NDI2Zjg3NmY4NjVkNw==
+    M2I5NWQ0OGU4Zjg3MjdiNjZlNGFmNzIwY2M1NTM4YmM2NzU2NDYwOA==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    YjgyNGVmYjRlMTMwYjk3ZWVlNjI0ZDM3NDk3MzEyZjQ2MjY3YmQwZTgxM2I5
-    ZjI3YzJjZjE5YTIzYWZhNTRhOGM2ODc0YzVmYWYzODcxZDJhOTdkYWNlMTBm
-    YjZlNmZkMjUwNTY0M2ZlMzk4NmFlMGY5NjdlOTBlMzM0ZTU2NWY=
+    MzQ5ODk3NzNlMTM2NjIyMWM1MzY2NjNhYzc1ZWY1MWM1MTFjNWY1NjMxNjMx
+    YTY3MWEyZDM5NjA4OGRjMDFiNWJkMzMyMWFmMmQ5OTRkODIwMzRjMGMxNzE3
+    ZjdmNDcwN2JlNTBkMmQ5MDJkNWVjMWI3NzRlZWE4ZDMwOGI1ZmM=
   data.tar.gz: !binary |-
-    MDRmYmE5ZDcxNjQ0OWQ2YjEyOTllNWE0ZDAzZmYyYTQ0MDc5YjcxNDFhNmE3
-    MjQzZjc5NjVlNTQxNDA0ZDNiNDI5ZjQ4MmUwNDg2MjA3NGQxNmM4MWYxODI1
-    MWExZmJjZmMzZDIyMGUzOTFkMThlZDg2YWUwNmI2ZTI2OTM5ZjE=
+    NmE4YmZiN2E0NjMzYjQ0NzE0ZTBlZTFjZjEyYTg5YjA1OGJjYmNmMjM0ZTY5
+    YmJjYjc4MjM0YWY5ZGJhY2U0NzIwZDBjMmM2MGQ0ZDQzNjJmOGUwNjZiZWY3
+    M2Q3ZTE0OGZhY2YwY2RlZWNiNWVmMzE0ODU1OTcxNWQxOWM5NjQ=

data/README.md

@@ -1,7 +1,20 @@
 ## Corundum
+### Quickstart
+
+The corundum-skel executable templates all the basic files necessary for building
+a gem with corundum. It's cautious and will not overwrite existing files.
+
+
+```
+gem install corundum
+cd my-new-rubygem
+corundum-skel
+rake -T
+```
+
 ### Foolproof rubygems
 
-With Corudum added as a developement dependancy to your gemspec, and configured
+With Corundum added as a developement dependency to your gemspec, and configured
 (quickly) in your Rakefile you can do:
 
     rake release
@@ -49,7 +62,7 @@ Corundum certainly wouldn't exist without seattlerb's Hoe.
 
 Corundum's default documentation theme is lifted wholesale from Steve Smith's Modernizer theme for github pages.
 
-Obviously, Bundler and Rubygems are a prerequisite, and the team that works on them is pretty much amazing.
+Obviously, Bundler and Rubygems are a prerequisite, and the teams that works on them are pretty much amazing.
 
 ### Contributing
 
@@ -62,3 +75,7 @@ an RCov tasklib, for instance, or a Minitest one.  Mercurial.
 Make a pull request, and I'll get it merged.  If you're worried, we can talk it
 out in Issues or email, and we can hash out the form of a pull request that
 I'll commit to merging.
+
+### License
+
+MIT

data/bin/corundum-skel

@@ -1,53 +1,4 @@
-#! /bin/env ruby
+#! /usr/bin/env ruby
 # vi: set ft=ruby:
-require 'optparse'
-require 'corundum/configuration-store'
-require 'rake/application'
-
-skelfiles = [ {
-  :source => 'skel-files/rakefile',
-  :target => 'Rakefile',
-  :unless => Rake::Application::DEFAULT_RAKEFILES,
-},
-{
-  :source => 'skel-files/simplecov',
-  :target => '.simplecov',
-  :unless => ['.simplecov']
-},
-{
-  :source => 'skel-files/travis',
-  :target => '.travis.yml',
-  :unless => ['.travis.yml']
-},
-{
-  :source => 'skel-files/gemspec',
-  :target => 'gem.gemspec',
-  :unless => ['gemspec.rb', '*.gemspec'],
-},
-{
-  :source => 'skel-files/gemfile',
-  :target => 'Gemfile',
-  :unless => ['Gemfile'],
-} ]
-
-if %w{-h --help -help help}.include?(ARGV[0])
-  puts "Spits out skeleton files to start a gem with."
-  puts
-  puts "Will emit these files:"
-  puts skelfiles.map{|desc| desc[:target]}.join(", ")
-  puts
-  puts "Files are copied from the skel-files directory out of this search path:"
-  puts Corundum.configuration_store.valise
-  exit 0
-end
-
-skelfiles.each do |desc|
-  unless (found = desc[:unless].map{|pattern| Dir.glob(pattern)}.flatten).empty?
-    puts "Refusing to clobber existing '#{found.first}'"
-  else
-    File::open(desc[:target], "w") do |file|
-      file.write(Corundum.configuration_store.loaded[desc[:source]])
-    end
-    puts "Created #{desc[:target]}"
-  end
-end
+require 'corundum/cli/skelfiles'
+Corundum::CLI::Skelfiles.new(ARGV).go

data/lib/corundum/cli/skelfiles.rb

@@ -0,0 +1,95 @@
+require 'optparse'
+require 'corundum/configuration-store'
+require 'rake/application'
+
+module Corundum
+  module CLI
+    class Skelfiles
+      class Skelfile
+        def initialize(source, target, exclude)
+          @source, @target, @exclude = source, target, exclude
+          @message = "No attempt to create yet"
+        end
+        attr_reader :source, :target, :exclude, :message
+
+        def templates
+          Corundum.configuration_store.valise.templates("skel-files")
+        end
+
+        def create!(scope)
+          unless (found = exclude.map{|pattern| Dir.glob(pattern)}.flatten).empty?
+            @message = "Refusing to clobber existing '#{found.first}'"
+          else
+            File::open(target, "w") do |file|
+              contents = templates.contents(source)
+              case contents
+              when Tilt::Template
+                file.write(contents.render(scope, {}))
+              else
+                file.write(contents)
+              end
+            end
+            @message = "Created #{target}"
+          end
+        end
+      end
+
+      def initialize(args)
+        @args = args
+      end
+      attr_reader :args
+
+      SkelfileScope = Struct.new(:project_name)
+
+      def options
+        @options ||= OptionParser.new do |opti|
+          opti.banner = "Spits out skeleton files to start a gem with.\nUsage: #$0 [options]"
+          opti.on("-h", "--help", "This help message") do
+            puts opti
+            puts "Will emit these files:"
+            puts skelfiles.map{|desc| desc.target}.join(", ")
+            puts
+            puts "Files are copied from the skel-files directory out of this search path:"
+            puts Corundum.configuration_store.valise
+            exit 0
+          end
+
+          opti.on("-p", "--project NAME", "Sets the name of the project (defaults to dirname, i.e. '#{default_project_name}')") do |name| #ok
+            scope.project_name = name
+          end
+        end
+      end
+
+      def default_project_name
+        File.basename(Dir.pwd)
+      end
+
+      def scope
+        @scope ||= SkelfileScope.new(default_project_name)
+      end
+
+      def skelfiles
+        @skelfiles ||= [
+          Skelfile.new( 'rakefile',   'Rakefile',                       Rake::Application::DEFAULT_RAKEFILES),
+          Skelfile.new( 'simplecov',  '.simplecov',                     %w[.simplecov] ),
+          Skelfile.new( 'travis',     '.travis.yml',                    %w[.travis.yml] ),
+          Skelfile.new( 'gemspec',    "#{scope.project_name}.gemspec",  %w{gemspec.rb *.gemspec} ),
+          Skelfile.new( 'gemfile',    'Gemfile',                        %w[Gemfile] )
+        ]
+      end
+
+      def parse_args
+        options.parse(args)
+      end
+
+      def go
+        parse_args
+
+        skelfiles.each do |skelfile|
+          skelfile.create!(scope)
+          puts skelfile.message
+        end
+      end
+    end
+  end
+end

data/lib/corundum/default_configuration/skel-files/gemfile.erb

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+gem 'corundum'
+gemspec :name => "<%= project_name %>" #points to default '<%= project_name %>.gemspec'

data/lib/corundum/default_configuration/skel-files/{gemspec → gemspec.erb}

@@ -1,5 +1,5 @@
 Gem::Specification.new do |spec|
-  spec.name		= ""
+  spec.name		= "<%= project_name %>"
   #{MAJOR: incompatible}.{MINOR added feature}.{PATCH bugfix}-{LABEL}
   spec.version		= "0.0.1"
   author_list = {

data/lib/corundum/default_configuration/skel-files/rakefile

@@ -1,38 +1,82 @@
 # vim: set ft=ruby :
 require 'corundum/tasklibs'
 
+# This Rakefile makes use of the Corundum tasklibs to parameterize lots and
+# lots of tasks to build your gem. Most of this is (minimal) boilerplate, but
+# there are some places where you can configure exactly how the tasks should
+# work.
+#
+# If you haven't seen the pattern before, simply instantiating the tasklib
+# class (i.e. SomeTasklib.new) is enough to create all the tasks it's
+# responsible for. If you do need to configure a tasklib, you can give ::new a
+# block which will receive the tasklib to configure. c.f. QuestionableContent
+# for an example.
+#
+# (Further docs for all the Corundum tasklibs will be coming to an Internet
+# near you real soon now.)
 module Corundum
   Corundum::register_project(__FILE__)
 
+  # The Core tasklib coordinates the other tasks. Generally it doesn't need any
+  # configuration.
   core = Core.new
 
   core.in_namespace do
+    # The GemspecFiles tasklib is responsible for checking that all the files
+    # necessary for your gem are listed in the Gemfile. Usually you don't need
+    # to add any configuration. Of note is the "extra_files" configuration - a
+    # list of files that need to be included but that Corundum might not be
+    # able to detect on its own.
     GemspecFiles.new(core)
 
-    #Also available: 'unfinished': TODO and XXX
+    # QuestionableContent searches codefiles for words (especially in comments)
+    # that you might not want going out into the world. Note that QC is added 4
+    # times by default with different types of text.
+    #
+    # If QC is wrong about something (e.g. there's a completely legitimate
+    # reason that 'p' appears on a line) You can tag the line with an '#ok'
+    # comment to have QC ignore it.
+
+    # This default checks for unacceptable language (of both the profanity
+    # and -ism varieties) before release, as well as debugging statements
+    # like debugger, byebug, puts, p, etc. accidentally left in the code.
+    #
+    # Also available: 'unfinished': TODO and XXX
     ["debug", "profanity", "ableism", "racism"].each do |type|
       QuestionableContent.new(core) do |content|
         content.type = type
       end
     end
+
+    # Corundum won't let you release a gem where any tests fail. By default, it
+    # assumes RSpec is used to test the project (alternative implementations
+    # are anxiously encouraged!)
     rspec = RSpec.new(core)
-    cov = SimpleCov.new(core, rspec) do |cov|
-      cov.threshold = 70
-    end
 
-    gem = GemBuilding.new(core)
-    cutter = GemCutter.new(core,gem)
-    email = Email.new(core)
-    vc = Git.new(core) do |vc|
-      vc.branch = "master"
+    # To make sure that tests don't just pass because they're incomplete,
+    # Corundum also requires a coverage threshold, which we measure with
+    # Simplecov.  Coverage also figures into how we determine that files should
+    # be in the gemspec (covered files should be included, and included files
+    # should be covered)
+    SimpleCov.new(core, rspec) do |cov|
+      cov.threshold = 85
     end
 
-    yd = YARDoc.new(core)
+    # The tasks to actually take code + gemspec and package into a gem. All its
+    # configuration should be determined by the gemspec itself.
+    gem = GemBuilding.new(core)
 
-    docs = DocumentationAssembly.new(core, yd, rspec, cov)
+    # Tasks for uploading gems to rubygems.com - called GemCutter for
+    # historical reasons.
+    GemCutter.new(core,gem)
 
-    pages = GithubPages.new(docs)
+    # We require that the code for a gem be pushed before releasing, and tag
+    # the branch with the version of the gem automatically. Corundum assumes
+    # Git for version control - alternatives encouraged.
+    Git.new(core) do |vc|
+      vc.branch = "master"
+    end
   end
 end
 
-task :default => [:release, :publish_docs]
+task :default => [:release]

data/lib/corundum/default_configuration/skel-files/simplecov

@@ -2,4 +2,5 @@ SimpleCov.start do
   coverage_dir "corundum/docs/coverage"
   add_filter "./spec"
   add_filter "/vendor/bundle/"
+  formatter SimpleCov::Formatter::JSONFormatter
 end

data/lib/corundum/gemcutter.rb

@@ -5,7 +5,6 @@ module Corundum
   class GemCutter < Mattock::TaskLib
     default_namespace :gemcutter
 
-    setting(:gem_path, nil)
     setting(:build)
     setting(:gemspec)
     setting(:qa_rejections)

data/lib/corundum/simplecov.rb

@@ -85,6 +85,11 @@ module Corundum
           end
           unless config_string =~ /SimpleCov::Formatter::JSONFormatter/
             problems << ".simplecov doesn't refer to SimpleCov::Formatter::JSONFormatter"
+            problems << "in your .simplecov file, either: "
+            problems << "    add 'formatter SimpleCov::Formatter::JSONFormatter'"
+            problems << "  or"
+            problems << "    add 'SimpleCov::Formatter::JSONFormatter' to an existing"
+            problems << "    'formatter SimpleCov::Formatter::MultiFormatter'"
           end
           fail problems.join("\n") unless problems.empty?
         end

data/lib/corundum/version_control/git.rb

@@ -83,7 +83,7 @@ module Corundum
           merge = git("config", "--get", "branch.#{branch}.merge").first.split("/").last.chomp
 
           ancestor = git("merge-base", branch, "#{remote}/#{merge}").first.chomp
-          remote_rev = File::read(".git/refs/remotes/#{remote}/#{merge}").chomp
+          remote_rev = git("ls-remote", remote, merge).first.split(/\s+/).first
 
           unless ancestor == remote_rev
             fail "Unmerged changes with remote branch #{remote}/#{merge}\n#{ancestor.inspect}\n#{remote_rev.inspect}"

data/spec/smoking_spec.rb

@@ -18,7 +18,7 @@ module Corundum
     end
 
     it "should have some tasks" do
-      true.should be_true
+      expect(true).to be(true)
     end
   end
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: corundum
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Judson Lester
+- Evan Dorn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-25 00:00:00.000000000 Z
+date: 2015-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: corundum
@@ -135,6 +136,7 @@ description: ! "  A corundum is a synthetic gemstone - including synthetic rubie
   \ packaging and releasing the gem\n"
 email:
 - nyarly@gmail.com
+- evan@lrdesign.com
 executables:
 - corundum-skel
 extensions: []
@@ -194,6 +196,7 @@ extra_rdoc_files:
 files:
 - bin/corundum-skel
 - lib/corundum.rb
+- lib/corundum/cli/skelfiles.rb
 - lib/corundum/configuration-store.rb
 - lib/corundum/core.rb
 - lib/corundum/qa-report.rb
@@ -212,8 +215,8 @@ files:
 - lib/corundum/version_control/git.rb
 - lib/corundum/default_configuration/preferences.yaml
 - lib/corundum/default_configuration/skel-files/rakefile
-- lib/corundum/default_configuration/skel-files/gemspec
-- lib/corundum/default_configuration/skel-files/gemfile
+- lib/corundum/default_configuration/skel-files/gemspec.erb
+- lib/corundum/default_configuration/skel-files/gemfile.erb
 - lib/corundum/default_configuration/skel-files/travis
 - lib/corundum/default_configuration/skel-files/simplecov
 - README.md
@@ -281,7 +284,7 @@ metadata: {}
 post_install_message: 
 rdoc_options:
 - --title
-- corundum-0.4.1 RDoc
+- corundum-0.5.0 RDoc
 require_paths:
 - lib/
 required_ruby_version: !ruby/object:Gem::Requirement

data/lib/corundum/default_configuration/skel-files/gemfile

@@ -1,4 +0,0 @@
-source "https://rubygems.org"
-
-gem 'corundum'
-gemspec :name => "gem" #points to default 'gem.gemspec'