gem_polish 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c31a47f214bd4cbda2e76e059444aafa3adbb0d
-  data.tar.gz: 4cb8604e6284d299348292047c7338b121a089a1
+  metadata.gz: ac3062847f504d97ef2f042caeb28d8260568057
+  data.tar.gz: d715b9cbc2c326f9c89ff81007deb3a3a21d064e
 SHA512:
-  metadata.gz: ba2e88c89011f2461ffb435f551d4933a9a6e5759dc7e9ddbe0cef7de50c97d186a2d366407206f20324e52509b301cec4d2680691339a68e4eef04606541a3a
-  data.tar.gz: 2f998d5155526a21c6aa83f51a48ebad07d88d000f9836a048ac32558b6d6f1ba595e0238f02d9c4eef78e95a8c038ab624f575d0245f3f9212c3812926677d2
+  metadata.gz: 9053b78b5885b27d678fbbd900f544d81f822dd2950418559b1e2d99471757a74893eb7c322cbd0c193185210989b7c221a169ddcfdc7f6eb8f2a1daffe3ba8f
+  data.tar.gz: 759dfe1c8200cbee3bf328ba969832450589cf79fb1a1e377b8067c3fa9938060b8cb3bb08a5a096972118cca0ce5c383a96bf126f9e17808a6103ea77d7070f

data/lib/gem_polish/cli/polisher.rb

@@ -0,0 +1,166 @@
+require 'yaml'
+
+module GemPolish
+  class CLI::Polisher
+    def initialize(options, thor)
+      @options = options
+      @thor = thor
+      @defaults = set_defaults
+    end
+
+    def set_defaults
+      defaults_disabled? ? {} : read_from_conf_file
+    end
+
+    def insert_description
+      if description
+        @thor.gsub_file(gemspec, /TODO:.*summary.*(?=})/, description)
+        @thor.gsub_file(readme, /TODO:.*gem description/, description)
+      end
+    end
+
+    def insert_badges
+      if badges
+        @thor.insert_into_file(readme, after: /^#\s.*\n/, force: false) { badge_links }
+      end
+    end
+
+    def insert_coveralls
+      if parse_opt(:coveralls)
+        @thor.prepend_file(spec_helper, template(:coveralls) + "\n")
+        add_dev_dependency('simplecov', '0.7')
+        @thor.append_file(gemfile, %{gem 'coveralls', require: false})
+      end
+    end
+
+    def insert_rspec_conf
+      if parse_opt(:rspec_conf)
+        @thor.append_file(spec_helper, "\n" + template(:rspec_configuration))
+      end
+    end
+
+    def insert_travis
+      if t = parse_opt(:travis)
+        @thor.say_status :rewrite, relative_destination(travis)
+        File.write(travis, YAML.dump(travis_content(t)))
+      end
+    end
+
+    def git_user
+      user = @options[:git_user] || read_from_git_config
+      user.empty? ? "TODO: Write your name" : user
+    end
+
+    private
+
+    def description
+      @description ||= @options[:description]
+    end
+
+    BADGE_NAMES = {
+      'badge_fury' => 'Version',
+      'gemnasium' => 'Dependencies',
+      'travis' => 'Build Status',
+      'coveralls' => 'Coverage',
+      'code_climate' => 'Code Climate'
+    }
+
+    def badges
+      @badges ||= parse_opt(:badges)
+    end
+
+    def badge_links
+      "\n#{badges.map { |badge| badge_link(badge) }.join("\n")}\n"
+    end
+
+    def badge_link(badge)
+      path = "http://allthebadges.io/#{git_user}/#{gem_name}/#{badge}"
+      "[![#{BADGE_NAMES[badge]}](#{path}.png)](#{path})"
+    end
+
+    def read_from_git_config
+      # can it return nil?
+      `git config user.name`.to_s.chomp
+    end
+
+    def parse_opt(opt)
+      @options[opt] || @defaults[opt]
+    end
+
+    def read_from_conf_file
+      conf_file_present? ? load_conf_file : {}
+    end
+
+    def defaults_disabled?
+      @options[:no_default]
+    end
+
+    def conf_file_present?
+      File.exist?(conf_file)
+    end
+
+    def load_conf_file
+      YAML.load(File.read(conf_file)).each_with_object({}) do |(k, v), h|
+        h[k.to_sym] = v
+      end
+    end
+
+    def add_dev_dependency(gem, version = nil)
+      total_size = File.size(gemspec)
+      pos_before_end = total_size - 4
+      insertion = %{  spec.add_development_dependency "#{gem}"}
+      return if File.read(gemspec).match(/#{insertion}/)
+      insertion << %{, "~> #{version}"} if version
+
+      @thor.say_status :append, relative_destination(gemspec)
+      File.open(gemspec, 'r+') do |file|
+        file.seek(pos_before_end, IO::SEEK_SET)
+        file.puts(insertion)
+        file.puts('end')
+      end
+    end
+
+    def travis_content(opts)
+      c = { 'language' => 'ruby'}
+      c.merge((opts.is_a?(Hash) ? opts : { 'rvm' => opts }))
+    end
+
+    def relative_destination(dest)
+      d = File.expand_path(dest, @thor.destination_root)
+      @thor.relative_to_original_destination_root(d)
+    end
+
+    TEMPLATE_DIR = File.expand_path('../../../templates', __FILE__)
+    def template(name)
+      File.read("#{TEMPLATE_DIR}/#{name}.template")
+    end
+
+    def conf_file
+      "#{ENV['HOME']}/.gem_polish.yml"
+    end
+
+    def gem_name
+      File.basename(Dir.pwd)
+    end
+
+    def travis
+      ".travis.yml"
+    end
+
+    def spec_helper
+      "spec/spec_helper.rb"
+    end
+
+    def gemspec
+      "#{gem_name}.gemspec"
+    end
+
+    def gemfile
+      "Gemfile"
+    end
+
+    def readme
+      "README.md"
+    end
+  end
+end

data/lib/gem_polish/cli.rb

@@ -4,6 +4,7 @@ require 'yaml'
 module GemPolish
   class CLI < Thor
 
+    require 'gem_polish/cli/polisher'
     require 'gem_polish/cli/versioner'
     include Thor::Actions
 
@@ -24,18 +25,12 @@ module GemPolish
       desc: 'Bypasses ~/.gem_polish.yml. Defaults to false'
     def polish(name = '.')
       inside name do
-        default = options.has_key?('no_default') ? {} : def_conf
-
-        description = options[:description]
-        git_user_name = extract_git_user(options)
-        badges = parse_opt(:badges, options, default)
-        travis_opts = parse_opt(:travis, options, default)
-
-        insert_badges(badges, git_user_name, gem_name) if badges
-        insert_description(description) if description
-        insert_coveralls if parse_opt(:coverage, options, default)
-        insert_rspec_conf if parse_opt(:rspec_conf, options, default)
-        insert_travis(travis_opts) if travis_opts
+        p = Polisher.new(options, self)
+        p.insert_description
+        p.insert_badges
+        p.insert_coveralls
+        p.insert_rspec_conf
+        p.insert_travis
       end
     end
 
@@ -66,116 +61,6 @@ module GemPolish
         end
       end
     end
-
-    no_commands do
-      def parse_opt(opt, opts, default)
-        opts[opt] || default[opt]
-      end
-
-      def extract_git_user(options)
-       user = options[:git_user] || `git config user.name`.chomp
-       user.empty? ? "TODO: Write your name" : user
-      end
-
-      def insert_description(description)
-        gsub_file(gemspec, /TODO:.*summary.*(?=})/, description)
-        gsub_file(readme, /TODO:.*gem description/, description)
-      end
-
-      BADGE_NAMES = {
-        'badge_fury' => 'Version',
-        'gemnasium' => 'Dependencies',
-        'travis' => 'Build Status',
-        'coveralls' => 'Coverage',
-        'code_climate' => 'Code Climate'
-      }
-
-      def insert_badges(badges, user, gem)
-        insert_into_file(readme, after: /^#\s.*\n/, force: false) do
-          "\n#{badges.map { |badge| badge_link(badge, user, gem) }.join("\n")}\n"
-        end
-      end
-
-      def badge_link(badge, user, gem)
-        path = "http://allthebadges.io/#{user}/#{gem}/#{badge}"
-        "[![#{BADGE_NAMES[badge]}](#{path}.png)](#{path})"
-      end
-
-      def insert_coveralls
-        prepend_file(spec_helper, read_template(:coveralls) + "\n")
-        add_dev_dependency('simplecov', '0.7')
-        append_file(gemfile, %{gem 'coveralls', require: false})
-      end
-
-      def insert_rspec_conf
-        append_file(spec_helper, "\n" + read_template(:rspec_configuration))
-      end
-
-      def insert_travis(opts)
-        say_status :rewrite, relative_destination(travis)
-        File.write(travis, YAML.dump(travis_content(opts)))
-      end
-
-      def travis_content(opts)
-        c = { 'language' => 'ruby'}
-        c.merge((opts.is_a?(Hash) ? opts : { 'rvm' => opts }))
-      end
-
-      def relative_destination(dest)
-        d = File.expand_path(dest, destination_root)
-        relative_to_original_destination_root(d)
-      end
-
-      def def_conf
-        conf_file = "#{ENV['HOME']}/.gem_polish.yml"
-        conf = File.exists?(conf_file) ? YAML.load(File.read(conf_file)) : {}
-        conf.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
-      end
-
-      def gem_name
-        File.basename(Dir.pwd)
-      end
-
-      def travis
-        ".travis.yml"
-      end
-
-      def spec_helper
-        "spec/spec_helper.rb"
-      end
-
-      def gemspec
-        "#{gem_name}.gemspec"
-      end
-
-      def gemfile
-        "Gemfile"
-      end
-
-      def readme
-        "README.md"
-      end
-
-      TEMPLATE_DIR = File.expand_path('../../templates', __FILE__)
-      def read_template(name)
-        File.read("#{TEMPLATE_DIR}/#{name}.template")
-      end
-
-      def add_dev_dependency(gem, version = nil)
-        total_size = File.size(gemspec)
-        pos_before_end = total_size - 4
-        insertion = %{  spec.add_development_dependency "#{gem}"}
-        return if File.read(gemspec).match(/#{insertion}/)
-        insertion << %{, "~> #{version}"} if version
-
-        say_status :append, relative_destination(gemspec)
-        File.open(gemspec, 'r+') do |file|
-          file.seek(pos_before_end, IO::SEEK_SET)
-          file.puts(insertion)
-          file.puts('end')
-        end
-      end
-    end
   end
 end
 

data/lib/gem_polish/version.rb

@@ -1,3 +1,3 @@
 module GemPolish
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/lib/gem_polish/cli/polisher_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+describe GemPolish::CLI::Polisher do
+  let(:thor) do
+    double(
+      gsub_file: true, insert_into_file: true, say_status: true,
+      append_file: true, prepend_file: true
+    )
+  end
+
+  class GemPolish::CLI::Polisher
+    # we need to override this, otherwise it really reads
+    # the conf file
+    def load_conf_file
+      {}
+    end
+  end
+
+  def new_polisher(options)
+    GemPolish::CLI::Polisher.new(options, thor)
+    # need to stub this, otherwise it really reads from the conf file
+  end
+
+  describe "#set_defaults" do
+    it "returns empty if --no-default was passed" do
+      polisher = new_polisher(no_default: true)
+      polisher.set_defaults.should be_empty
+    end
+
+    it "returns empty when no conf file is present" do
+      polisher = new_polisher({})
+      polisher.stub(conf_file_present?: false)
+      polisher.set_defaults.should be_empty
+    end
+
+    it "loads conf file when present" do
+      polisher = new_polisher({})
+      conf_file = { a: 1}
+      polisher.stub(load_conf_file: conf_file)
+      polisher.set_defaults.should == conf_file
+    end
+  end
+
+  describe "#insert_description" do
+    it "does nothing when no desciption was passed" do
+      polisher = new_polisher({})
+      thor.should_not receive(:gsub_file)
+      polisher.insert_description.should be_nil
+    end
+
+    it "inserts description in gemspec and README" do
+      polisher = new_polisher(description: 'test')
+      thor.should receive(:gsub_file).twice
+      polisher.insert_description
+    end
+  end
+
+  describe "#git_user" do
+    it "returns the provided git user name" do
+      polisher = new_polisher(git_user: 'Tester')
+      polisher.git_user.should == 'Tester'
+    end
+
+    it "tries to read from git_config when nothing was provided" do
+      polisher = new_polisher({})
+      polisher.stub(read_from_git_config: 'Gitter')
+      polisher.git_user.should == 'Gitter'
+    end
+
+    it "returns a todo when there is no user in git config" do
+      polisher = new_polisher({})
+      polisher.stub(read_from_git_config: '')
+      polisher.git_user.should =~ /TODO/
+    end
+  end
+
+  describe "#insert_badges" do
+    it "does nothing when no badges were passed" do
+      polisher = new_polisher({})
+      thor.should_not receive(:insert_into_file)
+      polisher.insert_badges
+    end
+
+    it "inserts badges when badges are present" do
+      polisher = new_polisher(badges: ['travis'])
+      thor.should receive(:insert_into_file)
+      polisher.insert_badges
+    end
+  end
+end

data/spec/lib/gem_polish/cli/versioner_spec.rb

@@ -42,7 +42,7 @@ describe GemPolish::CLI::Versioner do
       versioner.instance_variable_set(:@version, versioner.extract_from_version_file)
     end
 
-    describe "#returns an updated version hash for the given bumper" do
+    describe "returns an updated version hash for the given bumper" do
       it "bumps revision" do
         res = {
           'major' => 2,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gem_polish
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - LFDM
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-28 00:00:00.000000000 Z
+date: 2014-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -92,11 +92,13 @@ files:
 - gem_polish.thor
 - lib/gem_polish.rb
 - lib/gem_polish/cli.rb
+- lib/gem_polish/cli/polisher.rb
 - lib/gem_polish/cli/versioner.rb
 - lib/gem_polish/version.rb
 - lib/templates/coveralls.template
 - lib/templates/rspec_configuration.template
 - spec/gem_polish_spec.rb
+- spec/lib/gem_polish/cli/polisher_spec.rb
 - spec/lib/gem_polish/cli/versioner_spec.rb
 - spec/spec_helper.rb
 homepage: ''
@@ -125,5 +127,6 @@ specification_version: 4
 summary: Command line tool to help with gem creation and maintenance
 test_files:
 - spec/gem_polish_spec.rb
+- spec/lib/gem_polish/cli/polisher_spec.rb
 - spec/lib/gem_polish/cli/versioner_spec.rb
 - spec/spec_helper.rb