anvil-core 0.0.1.pre.alpha.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d11c632bfef80657b2626182273510e405208c03
-  data.tar.gz: 191dab915a4d5e375f421145dd4e84c2dc9ad35f
+  metadata.gz: 1ec595224814976ccada12c8a43dc3041bb43cca
+  data.tar.gz: d31891f5299ddd11c15e30317eb33ac10e737ab8
 SHA512:
-  metadata.gz: 786e8d0568a15e2490d5a57335dac9e12183f6425441df80383c455e5c0158183cb13d34bcf3c6af13398e53499bd3d0cd57b1df9568733df40957a547c7c73b
-  data.tar.gz: a026c61d5e629bd7aecf88ec5cd28b3462420956a7278ca924c323676c091813678e67bb75b0bea19fd0857b0e137a743ffa2f7a9f75451232d2bd4418a54c56
+  metadata.gz: 1e86c8cef457da7957997a36c0cf976e5181e0a3e45789036ec6454ebf35f0b557b6c73cf98f54a8b0dc81ab8b4244f2c41cc2ea8293ce510c79185434369fd2
+  data.tar.gz: c55729de1caf67c05e1a4fe5e3d5f96a0dae0e68c0f65d29f607e9ce2db686189707d3f8ac559f836edae4c062347a1a84c3db1c82b6393a8711f134949c91dd

data/README.md

@@ -4,12 +4,11 @@ Anvil is a tool for the real craftsmen to build its own tools.
 
 [![Build Status](https://travis-ci.org/anvil-src/anvil-core.png?branch=master)](https://travis-ci.org/anvil-src/anvil-core)
 
-
 Anvil tries to be a framework for building command line applications
 to automate tedious tasks like apps or gems releasing process. Pull
 request updating, etc.
 
-It's purpose is to provide an easy to use Object Oriented framework
+It's purpose is to provide an easy to use Object Oriented toolset
 that developers can use to automate par of its day to day work.
 
 Things like:
@@ -19,6 +18,14 @@ Things like:
   * Doing complex build which involve several projects and branches.
   * Any other stuff you might want.
 
+## Sample tasks
+
+You can find some sample tasks in the samples directory, if you want to give them a try, clone this project and do:
+
+```shell
+ANVIL_TASKS_DIR=./sample bin/anvil
+```
+
 ## Installation
 
 To install it:

data/VERSION

@@ -1 +1 @@
-0.0.1-alpha.3
+0.1.0

data/lib/anvil.rb

@@ -1,6 +1,9 @@
+# encoding: UTF-8
+
 require 'anvil/version'
 require 'active_support/core_ext'
 
+# Main anvil module
 module Anvil
   Error = Class.new(StandardError)
 

data/lib/anvil/assure.rb

@@ -1,4 +1,7 @@
+# encoding: UTF-8
+
 module Anvil
+  # Basic precondition for the tasks. If this fails, the task stops
   class Assure
     class << self
       def from_name(assure_name)

data/lib/anvil/assures/directory_assure.rb

@@ -1,4 +1,7 @@
+# encoding: UTF-8
+
 module Anvil
+  # Make sure that a directory exists before running the task
   class DirectoryAssure < Anvil::FileAssure
     def assured?(dir)
       super && assure_dir?(dir)

data/lib/anvil/assures/file_assure.rb

@@ -1,4 +1,7 @@
+# encoding: UTF-8
+
 module Anvil
+  # Make sure that a file exists before running the task
   class FileAssure < Anvil::Assure
     def assured?(file)
       assure_exists? file

data/lib/anvil/bundler.rb

@@ -0,0 +1,8 @@
+module Anvil
+  class Bundler
+    def update_gem(gem_name)
+      line = Cocaine::CommandLine.new('bundle', 'update :gem')
+      line.run gem: gem_name
+    end
+  end
+end

data/lib/anvil/cli.rb

@@ -1,7 +1,10 @@
+# encoding: UTF-8
+
 require 'anvil/task_manager'
 require 'tasks/help_task'
 
 module Anvil
+  # Anvil command line interface
   class Cli
     HELP = <<-HELP
 Anvil is a tool for making your life easier.
@@ -9,6 +12,10 @@ Anvil is a tool for making your life easier.
 Available tasks:
 HELP
 
+    # Runs a task or prints its help if it needs arguments
+    #
+    # @param argv [Array] Command line arguments
+    # @return [Object, nil] Anything the task returns
     def run(argv)
       load_tasks
 
@@ -23,6 +30,10 @@ HELP
       Anvil::TaskManager.load_tasks
     end
 
+    # Builds a task and prepares it to run
+    #
+    # @param argv [Array] Command line arguments
+    # @return [Anvil::Task] A task ready to run
     def build_task(argv)
       arguments = argv.dup
       task_name = arguments.shift

data/lib/anvil/config.rb

@@ -1,8 +1,11 @@
+# encoding: UTF-8
+
 require 'mixlib/config'
 require 'anvil/config/class_methods'
 require 'gem_ext/mixlib'
 
 module Anvil
+  # Configuration management
   module Config
     extend Mixlib::Config
     extend Anvil::Config::ClassMethods

data/lib/anvil/config/class_methods.rb

@@ -1,7 +1,10 @@
+# encoding: UTF-8
+
 require 'fileutils'
 
 module Anvil
   module Config
+    # Configuration initialization
     module ClassMethods
       def base_path
         File.expand_path('~/.anvil')

data/lib/anvil/parser.rb

@@ -1,4 +1,9 @@
+# encoding: UTF-8
+
+require 'anvil/task'
+
 module Anvil
+  # Parser for anvil command line arguments and options
   class Parser < OptionParser
     attr_accessor :options
     attr_accessor :task
@@ -7,10 +12,9 @@ module Anvil
       @options ||= {}
     end
 
-    def arguments(args = [])
-      @arguments ||= []
-      @arguments += args if args.any?
-      @arguments.compact
+    def arguments(args = nil)
+      return @arguments if @arguments
+      @arguments = [args.presence].compact.flatten
     end
 
     def banner
@@ -30,5 +34,10 @@ module Anvil
 
       message
     end
+
+    def from(name)
+      task_klass = Anvil::Task.from_name(name)
+      instance_eval(&task_klass.parser_block) if task_klass.parser_block
+    end
   end
 end

data/lib/anvil/rubygems.rb

@@ -1,14 +1,23 @@
+# encoding: UTF-8
+
 require 'cocaine'
 
 module Anvil
+  # Rubygems wrapper for common commands
   class Rubygems
     class << self
+      # Runs gem build for a gemspec
+      #
+      # @param gemspec [String] The gemspec's filename
       def build(gemspec)
         line = Cocaine::CommandLine.new 'gem', 'build :gemspec'
 
         line.run gemspec: gemspec
       end
 
+      # Runs gem install for a gem file
+      #
+      # @param gem_file [String] The gems' filename
       def install(gem_file)
         line = Cocaine::CommandLine.new 'gem', 'install :gem_file'
 

data/lib/anvil/task.rb

@@ -1,8 +1,11 @@
+# encoding: UTF-8
+
 require 'anvil/task/class_methods'
 require 'anvil/task/naming'
 require 'anvil/task/options'
 
 module Anvil
+  # Common class for all tasks
   class Task
     extend ClassMethods
     extend Naming
@@ -14,11 +17,16 @@ module Anvil
       @options = options
     end
 
+    # Runs a task and its callbacks if the assures are OK
+    #
+    # @return [Object, nil] anything the task might return
     def run
       if run_assures
         run_before_callbacks
-        run_task
+        task_return_value = run_task
         run_after_callbacks
+
+        task_return_value
       end
     end
 

data/lib/anvil/task/class_methods.rb

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 require 'optparse'
 
 module Anvil

data/lib/anvil/task/naming.rb

@@ -2,11 +2,16 @@ require 'active_support/core_ext/string'
 
 module Anvil
   class Task
+    # Methods for inferring task class names from cli arguments
     module Naming
       def get_namespace(task_name)
         task_name.to_s.split ':'
       end
 
+      # Returns a ruby class from a CLI name
+      #
+      # @param task_name [String] the CLI name for a task e.g. anvil:build
+      # @return [Class] an {Anvil::Task} descendant
       def from_name(task_name)
         namespaced_task     = get_namespace task_name
         camelized_task      = "#{namespaced_task.pop}_task".camelize

data/lib/anvil/task/options.rb

@@ -1,17 +1,23 @@
+# encoding: utf-8
+
 require 'anvil/parser'
 
 module Anvil
   class Task
+    # Cli options parsing definition
     module Options
+      attr_reader :parser_block
+
       def help
         parser.help
       end
 
       def parser(&block)
-        @parser ||= define_parser(&block)
+        @parser_block = block
+        @parser ||= build_parser(&block)
       end
 
-      def define_parser(&block)
+      def build_parser(&block)
         parser = Anvil::Parser.new
         parser.task = self
         configure_parser(parser, &block)

data/lib/anvil/task/repositories.rb

@@ -1,5 +1,8 @@
+# encoding: UTF-8
+
 module Anvil
   class Task
+    # Tools to work with github repositories
     module Repositories
       def resolve_url(url)
         if url =~ /^\w+\/\w+$/

data/lib/anvil/task_manager.rb

@@ -1,43 +1,70 @@
+# encoding: UTF-8
+
+require 'rubygems'
 require 'anvil/config'
 require 'anvil/task'
-require 'rubygems'
+require 'rugged'
 
 module Anvil
+  # Manage loading and finding anvil tasks
   module TaskManager
     @tasks_loaded = false
 
+    # Loads all known anvil tasks
     def self.load_tasks
       all_files.each { |file| load(file) }
       @tasks_loaded = true
     end
 
+    # @return [Array] all the core anvil tasks
     def self.files_from_anvil
       files_from_path(File.expand_path('../..', __FILE__))
     end
 
+    # @return [Array] all possible anvil tasks in this project
     def self.files_from_current_project
       path = current_project_path + '/lib/anvil/'
       files_from_path(path)
     end
 
+    # @return [String] top level dir if this is a git managed project
     def self.current_project_path
-      %x{git rev-parse --show-toplevel}.strip
+      Rugged::Repository.discover(ENV['PWD']).gsub('.git/', '')
+    rescue Rugged::RepositoryError
+      ''
     end
 
+    # @param path [String] a path to glob their anvil tasks
+    # @return [Array] all anvil tasks in the given path
     def self.files_from_path(path)
       Dir[path + '/tasks/**/*_task.rb']
     end
 
+    # @return [Array] anvil tasks installed in gems
     def self.files_from_gems
       Gem.find_latest_files 'anvil/tasks/**/*_task.rb'
     end
 
+    # @return [Array] anvil tasks in the specified dir
+    def self.files_from_env
+      if ENV['ANVIL_TASKS_DIR']
+        env_dir_list = ENV['ANVIL_TASKS_DIR'].split(':').join(',')
+
+        Dir["{#{env_dir_list}}/*_task.rb"]
+      else
+        []
+      end
+    end
+
+    # @return [Array] all known anvil task files
     def self.all_files
-      [files_from_anvil,
+      [files_from_env,
+       files_from_anvil,
        files_from_current_project,
        files_from_gems].compact.reduce(&:+).uniq
     end
 
+    # @return [Array] all known {Anvil::Task} desdendants
     def self.all_tasks
       load_tasks unless @tasks_loaded
       ::Anvil::Task.descendants

data/lib/tasks/gem/bump_task.rb

@@ -5,13 +5,18 @@ class Gem::BumpTask < Anvil::Task
   description "Bumps a gem's version"
 
   parser do
-    arguments %w[term]
+    arguments %w(term)
+
+    on('-p', '--[no-]persist', 'Commit tag and push the changes') do |p|
+      options[:persist] = p
+    end
   end
 
   attr_reader :term
 
   def initialize(term, options = {})
-    @term = term
+    @term = term.to_sym
+    @options = options
   end
 
   def task
@@ -58,7 +63,7 @@ class Gem::BumpTask < Anvil::Task
       f.close
     end
 
-    commit_and_tag version
+    commit_and_tag version if options[:persist]
   end
 
   def prepare_repo

data/lib/tasks/help_task.rb

@@ -4,7 +4,7 @@ class HelpTask < Anvil::Task
   description 'Help for the anvil tasks. Usage: anvil help TASK'
 
   parser do
-    arguments %w[task_name]
+    arguments %w(task_name)
   end
 
   attr_reader :task_name

data/spec/lib/anvil/parser_spec.rb

@@ -0,0 +1,17 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+describe Anvil::Parser do
+  let(:task) { DummyTask }
+
+  describe '#from' do
+    before do
+      task.stub(:parser_block).and_return(proc { 'opts' })
+    end
+
+    it 'inherits parser block from another task' do
+      expect(subject.from('dummy')).to eq('opts')
+    end
+  end
+end

data/spec/lib/anvil/task/options_spec.rb

@@ -1,33 +1,75 @@
+# encoding: UTF-8
+
 require 'spec_helper'
 require 'anvil/task/options'
 
 describe Anvil::Task::Options do
-  let(:klass) { DummyTask }
+  let(:klass) do
+    Class.new do
+      def self.description
+        'Dummy task'
+      end
+      extend Anvil::Task::Options
+    end
+  end
 
-  describe '.define_parser' do
+  describe '.build_parser' do
     it 'returns an instance of Anvil::Parser' do
-      expect(klass.define_parser).to be_kind_of(Anvil::Parser)
+      expect(klass.build_parser).to be_kind_of(Anvil::Parser)
     end
   end
 
   describe '.parse_options!' do
-    let(:klass) do
-      Class.new(DummyTask) do
-        parser do
-          on('-i', '--install') do |i|
-            options[:install] = i
+    context 'with more than one argument and options' do
+      before do
+        klass.class_eval do
+          parser do
+            arguments %w(arg1 arg2)
+            on('-i', '--install') do |i|
+              options[:install] = i
+            end
           end
         end
       end
+      let(:arguments) { %w(arg1 arg2 --install) }
+      let(:expected)  { ['arg1', 'arg2', { install: true }] }
+
+      it 'returns the correct arguments and options' do
+        expect(klass.parse_options!(arguments)).to be_eql(expected)
+      end
     end
 
-    let(:arguments) { %w{arg1 arg2 --install} }
+    context 'with one argument and options' do
+      before do
+        klass.class_eval do
+          parser do
+            arguments %w(arg1)
+            on('-i', '--install') do |i|
+              options[:install] = i
+            end
+          end
+        end
+      end
+      let(:arguments) { %w{arg1 --install} }
+      let(:expected)  { ['arg1', { install: true }] }
 
-    let(:expected) do
-      ['arg1', 'arg2', { install: true }]
+      it 'returns the correct arguments and options' do
+        expect(klass.parse_options!(arguments)).to be_eql(expected)
+      end
     end
-    it 'returns the correct arguments and options' do
-      expect(klass.parse_options!(arguments)).to be_eql(expected)
+
+    context 'only with one argument' do
+      let(:arguments) { %w(arg1) }
+      let(:expected)  { arguments }
+      let(:parser_block) do
+        proc do
+          arguments %w(arg1)
+        end
+      end
+
+      it 'returns the correct arguments and options' do
+        expect(klass.parse_options!(arguments)).to be_eql(expected)
+      end
     end
   end
 end

data/spec/lib/anvil/task_manager_spec.rb

@@ -21,6 +21,33 @@ describe Anvil::TaskManager do
     end
   end
 
+  describe '.current_project_path' do
+    let(:pwd) { '/home/user/src/project/' }
+    context 'on a path managed by git' do
+      before do
+        Rugged::Repository.stub(:discover)
+          .and_return(pwd + '.git/')
+      end
+
+      it 'returns the repo workdir' do
+        expect(described_class.current_project_path)
+          .to eq(pwd)
+      end
+    end
+
+    context 'on a path not managed by git' do
+      before do
+        Rugged::Repository.stub(:discover)
+          .and_raise(Rugged::RepositoryError)
+      end
+
+      it 'returns an empty string' do
+        expect(described_class.current_project_path)
+          .to be_empty
+      end
+    end
+  end
+
   describe '.files_from_gems' do
     it 'asks Gem to return the anvil tasks' do
       expect(Gem).to receive(:find_latest_files).with('anvil/tasks/**/*_task.rb')
@@ -28,6 +55,14 @@ describe Anvil::TaskManager do
     end
   end
 
+  describe '.files_from_env' do
+    context 'with empty env variable' do
+      it 'returns an empty array' do
+        expect(described_class.files_from_env).to eq([])
+      end
+    end
+  end
+
   describe '.load_tasks' do
     let(:all_files) { %w[file1 file2] }
 

data/spec/lib/tasks/gem/bump_task_spec.rb

@@ -4,7 +4,7 @@ require 'git'
 require 'anvil'
 
 describe Gem::BumpTask do
-  subject { Gem::BumpTask.new :major }
+  subject { Gem::BumpTask.new 'major' }
 
   describe '#task' do
     before  { subject.stub(:read_version).and_return('2.0.0') }
@@ -18,9 +18,19 @@ describe Gem::BumpTask do
   end
 
   describe '#write_version' do
-    it 'writes the file and push the changes' do
-      expect(subject).to receive(:version_file).with('w+')
-      expect(subject).to receive(:commit_and_tag)
+    context 'when persisting' do
+      subject { Gem::BumpTask.new 'major', persist: true }
+      it 'writes the file and push the changes' do
+        expect(subject).to receive(:version_file).with('w+')
+        expect(subject).to receive(:commit_and_tag)
+      end
+    end
+
+    context 'when no persisting' do
+      it 'writes the file but does not persist the change in git' do
+        expect(subject).to receive(:version_file).with('w+')
+        expect(subject).to_not receive(:commit_and_tag)
+      end
     end
 
     after { subject.send :write_version, '2.0.0' }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: anvil-core
 version: !ruby/object:Gem::Version
-  version: 0.0.1.pre.alpha.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Fran Casas
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-07 00:00:00.000000000 Z
+date: 2014-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: mixlib-config
   requirement: !ruby/object:Gem::Requirement
@@ -81,6 +81,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rugged
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -139,7 +153,7 @@ dependencies:
         version: '0.18'
 description: Anvil is a tool for building tools.
 email:
-- nflamel@otrobloggeek.com
+- nflamel@gmail.com
 - jondeandres@gmail.com
 executables:
 - anvil
@@ -156,6 +170,7 @@ files:
 - lib/anvil/assure.rb
 - lib/anvil/assures/directory_assure.rb
 - lib/anvil/assures/file_assure.rb
+- lib/anvil/bundler.rb
 - lib/anvil/cli.rb
 - lib/anvil/config.rb
 - lib/anvil/config/class_methods.rb
@@ -181,6 +196,7 @@ files:
 - spec/lib/anvil/assures/file_assure_spec.rb
 - spec/lib/anvil/cli_spec.rb
 - spec/lib/anvil/config_spec.rb
+- spec/lib/anvil/parser_spec.rb
 - spec/lib/anvil/task/naming_spec.rb
 - spec/lib/anvil/task/options_spec.rb
 - spec/lib/anvil/task_manager_spec.rb
@@ -216,12 +232,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Anvil is a tool for building tools. A tool that a real craftsmen uses to
@@ -232,6 +248,7 @@ test_files:
 - spec/lib/anvil/assures/file_assure_spec.rb
 - spec/lib/anvil/cli_spec.rb
 - spec/lib/anvil/config_spec.rb
+- spec/lib/anvil/parser_spec.rb
 - spec/lib/anvil/task/naming_spec.rb
 - spec/lib/anvil/task/options_spec.rb
 - spec/lib/anvil/task_manager_spec.rb