evoke 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: de1ac06c3626655a6e1d041392fd749cfde7c820
+  data.tar.gz: 7d634505e1b52a26b03bc2aaef687678f458d62e
+SHA512:
+  metadata.gz: 3bef13d6b793bbdaa4225cdf375579a2788e05b3dd47fa508ce301ce2e9f4c6809b847d69f26d127a3773b974866b833b6a37fd82468c22761ea20bd93e76a2e
+  data.tar.gz: 9b12056349fedfbbf8845e135f1303a574b6e8a637c13fa77b3a252894fa63ce67b070f4c777b739780c5a9464e29af8fe8b2f58dc6cf80af8a25fbb646d466b

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,27 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people
+who contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual
+language or imagery, derogatory comments or personal attacks, trolling, public
+or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct. Project maintainers who do not follow the
+Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by opening an issue or contacting one or more of the project
+maintainers.
+
+This Code of Conduct is adapted from the
+[Contributor Covenant](http:contributor-covenant.org),
+[version 1.0.0](http://contributor-covenant.org/version/1/0/0/).

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in evoke.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Travis Haynes
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 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.

data/README.md

@@ -0,0 +1,129 @@
+# Evoke
+
+A lightweight, zero-dependency task tool for Ruby.
+
+## Installation
+
+    $ gem install evoke
+
+## Usage
+
+### Writing Tasks
+
+Evoke tasks are Ruby classes that look like this:
+
+```ruby
+class HelloWorld < Evoke::Task
+  # This description appears when your run `evoke` without any arguments.
+  desc "Prints a friendly message"
+
+  # This method is called by Evoke when the task is executed.
+  def invoke
+    puts "Hello world!"
+  end
+end
+```
+
+**Important:** Initializers for Evoke::Tasks cannot have any required arguments.
+
+This task would be invoked from the command-line with `evoke hello_world`.
+
+#### Namespacing
+
+Tasks are namespaced using modules. Their command names are underscored from
+their Ruby class names. For example, a task named `Example::HelloWorld` would be
+invoked on the command line with `evoke example/hello_world`.
+
+#### Command-line-arguments
+
+Here's an example of a task that uses command-line arguments and is namespaced.
+
+```ruby
+module Math
+  class Add < Evoke::Task
+    desc "Adds two integers and prints the result in the console"
+
+    def invoke(a, b)
+      puts a.to_i + b.to_i
+    end
+  end
+end
+```
+
+**Note:** All arguments come through as strings since they are read from the
+command-line.
+
+This task would be invoked from the command-line with `evoke math/add 5 10`,
+where a=5 and b=10 in this example.
+
+Switches are not currently supported. Use environment variables to use named
+arguments. Here's the same example as above using environment variables:
+
+```ruby
+module Math
+  class Add < Evoke::Task
+    desc "Adds two integers and prints the result in the console"
+
+    def initialize
+      @a = ENV['A'].to_i
+      @b = ENV['B'].to_i
+    end
+
+    def invoke
+      puts @a + @b
+    end
+  end
+end
+```
+
+This task would be invoked from the command-line with `evoke math/add A=5 B=10`.
+
+### Loading Tasks
+
+There are two ways tasks can be loaded.
+
+1. Place the tasks in the working directory's lib/tasks folder and end the file
+names with `_task.rb`.
+2. Create a file named `evoke.rb` and load the tasks manually or place them
+directly in that file.
+
+Running `evoke` from the command line will scan the current working directory.
+It will first search for a file named `evoke.rb`. If found, Evoke will assume
+this file takes care of loading the tasks. Otherwise the `lib/tasks` folder will
+be recursively searched for `_task.rb` files, which will be loaded in the order
+they are found.
+
+Here's an example `evoke.rb` file for using Evoke with a Rails application:
+
+```ruby
+# Searches the lib/evoke folder for _task.rb files and loads them.
+Evoke.load_tasks('lib/evoke')
+
+# Load the Rails environment before a task is invoked.
+Evoke.before_task do |task, *args|
+  require File.expand_path("../config/environment.rb", __FILE__)
+end
+```
+
+Note that the Rails environment is loaded in a #before_task callback. This makes
+sure that the environment only loads when the task is actually being invoked,
+and not when the user is simply trying to list the available tasks or made a
+mistake in the task's name or arguments.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release` to create a git tag for the version, push git commits
+and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. [Fork it](https://github.com/travishaynes/evoke/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'evoke'
+require 'irb'
+
+IRB.start

data/bin/setup

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/evoke.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'evoke/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'evoke'
+  spec.version = Evoke::VERSION
+  spec.authors = ['Travis Haynes']
+  spec.email = ['travis@hi5dev.com']
+
+  spec.summary = 'A build tool for Ruby.'
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.8'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.5.1'
+end

data/exe/evoke

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'evoke'
+require 'evoke/cli'
+
+cli = Evoke::CLI.new
+cli.start

data/lib/evoke/cli.rb

@@ -0,0 +1,84 @@
+module Evoke
+  # The command-line-interface for Evoke.
+  class CLI
+    def initialize
+      @command = ARGV.shift
+      @arguments = ARGV.dup
+
+      ARGV.clear
+    end
+
+    # Starts the CLI. This will check lib/tasks in the current working directory
+    # for evoke tasks and invoke the task supplied on the command line.
+    def start
+      load_tasks
+
+      return usage if @command.nil?
+
+      task = Evoke.find_task(@command) unless @command.nil?
+
+      return unknown_command if task.nil?
+
+      Evoke.invoke(task, *@arguments)
+    end
+
+    # Prints the usage for all the discovered tasks.
+    def usage
+      name_col_size = task_names.group_by(&:size).keys.max + 2
+      tasks.each {|task| task.print_usage(name_col_size) }
+
+      exit(2)
+    end
+
+    private
+
+    # Gets the path for the local evoke.rb file. This doesn't check if the file
+    # actually exists, it only returns the location where it might be.
+    #
+    # @return [String] The path for the evoke file.
+    def evoke_file
+      @evoke_file = File.join(Dir.pwd, "evoke.rb")
+    end
+
+    # Loads the Evoke tasks. This will first search for a file named `evoke.rb`
+    # in the current working directory. If one is found it will be loaded. If
+    # none is found the default working directory's lib/tasks folder will be
+    # used to load the tasks.
+    def load_tasks
+      return load(evoke_file) if File.file?(evoke_file)
+
+      # Load the tasks from the current working directory.
+      Evoke.load_tasks("lib/tasks")
+
+      # No reason to continue if there are no tasks to work with.
+      return no_tasks if tasks.empty?
+    end
+
+    # Tells the user there are no tasks to invoke and exits with status 1.
+    def no_tasks
+      STDERR.puts "No tasks found in the current working directory."
+      exit(1)
+    end
+
+    # Tells the user that the supplied task could not be found.
+    def unknown_command
+      STDERR.puts "No task for #{@command.inspect}"
+      exit(1)
+    end
+
+    # Finds and caches all the Evoke tasks.
+    #
+    # @return [Array] The tasks.
+    def tasks
+      @tasks ||= Evoke.tasks
+    end
+
+    # Gets the underscored names of all the tasks and caches it. These are the
+    # names are that used on the command line.
+    #
+    # @return [Array] The name of all the tasks.
+    def task_names
+      @task_names ||= tasks.map {|task| task.name.underscore }
+    end
+  end
+end

data/lib/evoke/inflections/camelize.rb

@@ -0,0 +1,35 @@
+# String inflections for converting to CamelCase.
+#
+# Camelizing a string takes all the compound words separated by an underscore
+# and combines them together, capitalizing the first letter of each word. It
+# also converts '/' to '::'. For example "hello_world" is camelized to
+# "HelloWorld", and "hello/world" is camelized to "Hello::World".
+module Evoke::Inflections::Camelize
+  # Converts a string to CamelCase. It also converts '/' to '::'.
+  #
+  # @example Camelize the string "example/hello_world".
+  #
+  #     "example/hello_world".camelize # => "Example::HelloWorld"
+  #
+  # @return [String] The CamelCase string.
+  def camelize
+    dup.tap {|s|
+      s.capitalize!
+      s.gsub!(/(?:_|(\/))([a-z\d]*)/i) { "#{$1}#{$2.capitalize}" }
+      s.gsub!("/", "::")
+    }
+  end
+
+  # Replaces the existing String instance with a CamelCase string.
+  #
+  # @example Camelizing the string "example/hello_world".
+  #
+  #     string = "example/hello_world"
+  #     string.camelize!
+  #     string # => "Example::HelloWorld"
+  #
+  # @return [String] This string modified to CamelCase.
+  def camelize!
+    replace(camelize)
+  end
+end

data/lib/evoke/inflections/underscore.rb

@@ -0,0 +1,38 @@
+# String inflections for converting to underscored form.
+#
+# Underscoring a string injects an underscore between CamelCase words, replaces
+# all '::' with '/' and converts the string to lowercase. For example, the
+# string "HelloWorld" is underscored to "hello_world", and the string
+# "Hello::World" is underscored to "hello/world".
+module Evoke::Inflections::Underscore
+  # Creates an underscored, lowercase form of the string and changes '::' to '/'
+  # to convert namespaces to paths.
+  #
+  # @example Underscoring "Example::HelloWorld".
+  #
+  #     "Example::HelloWorld" # => "example/hello_world"
+  #
+  # @return [String] The underscored string.
+  def underscore
+    dup.tap {|s|
+      s.gsub!(/::/, '/')
+      s.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+      s.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+      s.tr!("-", "_")
+      s.downcase!
+    }
+  end
+
+  # Replaces the existing String instance with its underscored form.
+  #
+  # @example Underscoring the string "Example::HelloWorld".
+  #
+  #     string = "Example::HelloWorld"
+  #     string.underscore!
+  #     string # => "example/hello_world"
+  #
+  # @return [String] This underscored form of the original string.
+  def underscore!
+    replace(underscore)
+  end
+end

data/lib/evoke/inflections.rb

@@ -0,0 +1,11 @@
+module Evoke
+  # Inflections define new methods on the String class to transform names for
+  # different purposes.
+  module Inflections
+    # Load the inflections.
+    Dir[File.expand_path("../inflections/*.rb", __FILE__)].each {|f| require f }
+
+    # Add the inflections to the String class.
+    constants.each {|i| String.send(:include, const_get(i)) }
+  end
+end

data/lib/evoke/task.rb

@@ -0,0 +1,44 @@
+module Evoke
+  class Task
+    class << self
+      # Prints the usage of this task to the console.
+      #
+      # @param [Integer] name_col_size The size of the name column.
+      # @private
+      def print_usage(name_col_size)
+        $stdout.print name.underscore.ljust(name_col_size)
+        $stdout.puts "# #{@desc || 'No description.'}"
+      end
+
+      # Describes the task. This message will be printed to the console when
+      # evoke is called without any arguments.
+      #
+      # @note All descriptions end with a period. One will be added if missing.
+      #
+      # @param [String] value The description. Keep it short!
+      # @return [String] The supplied description.
+      def desc(value)
+        value += "." unless value.end_with?(?.)
+        @desc = value
+      end
+
+      # Ensures that the task's #invoke method has the same amount of arguments
+      # as the user supplied on the command-line. If not, an error message is
+      # printed to STDERR and Evoke is terminated with an exit-status of 1.
+      #
+      # @param [Array] arguments The arguments to validate.
+      # @return nil if the validation passes.
+      # @private
+      def validate_arguments(arguments)
+        e_size = instance_method(:invoke).arity
+        a_size = Array(arguments).size
+
+        return if e_size == a_size
+
+        $stderr.print "Wrong number of arguments. "
+        $stderr.print "Received #{a_size} instead of #{e_size}.\n"
+        exit(1)
+      end
+    end
+  end
+end

data/lib/evoke/version.rb

@@ -0,0 +1,3 @@
+module Evoke
+  VERSION = "0.1.1"
+end

data/lib/evoke.rb

@@ -0,0 +1,89 @@
+require 'evoke/version'
+require 'evoke/task'
+
+module Evoke
+  require 'evoke/inflections'
+
+  class << self
+    # Gets all the classes that descend from Evoke::Task.
+    #
+    # @return [Array] The task classes.
+    def tasks
+      ObjectSpace.each_object(Class).select {|klass| klass < Evoke::Task }
+    end
+
+    # Finds a task with the supplied name.
+    #
+    # @param [String] name The underscored name of the task.
+    # @return [Evoke::Task] The task or nil if not found.
+    # @example Find a task that has the class name `Example::HelloWorld`.
+    #
+    #     Evoke.find_task('example/hello_world') # => Example::HelloWorld
+    #
+    def find_task(name)
+      tasks.find {|task| task.to_s == name.camelize }
+    end
+
+    # Loads all the Evoke tasks in the supplied path.
+    #
+    # @example Loading tasks in the local "lib/tasks" folder.
+    #
+    #     Evoke.load_tasks("lib/tasks")
+    #
+    # @example Loading tasks with an absolute path name.
+    #
+    #     path = File.expand_path("../lib/evoke", __FILE__)
+    #     Evoke.load_tasks(path, false)
+    #
+    # @param [String] path The root path that contains the tasks.
+    # @param [Boolean] relative Path is relative to working directory (default).
+    # @return [Array] The files that were loaded.
+    def load_tasks(path, relative=true)
+      if relative
+        path = File.join(Dir.pwd, path)
+        path = File.expand_path(path)
+      end
+
+      Dir[File.join(path, "**", "*_task.rb")].each {|f| load f }
+    end
+
+    # Adds a code block that will be called before the task is invoked.
+    #
+    # @param [Proc] &block The code to execute before the task is invoked.
+    # @example Loading the Rails environment before running any Evoke tasks.
+    #
+    #     # File: evoke.rb - In the Rails application's root path
+    #
+    #     Evoke.before_task {|task, *args|
+    #       require File.expand_path("../config/environment.rb", __FILE__)
+    #     }
+    #
+    def before_task(&block)
+      @before_hooks ||= []
+      @before_hooks << block if block_given?
+    end
+
+    # Creates an instance of a task, validates the amount of arguments supplied
+    # matches the task's #invoke method, executes the #before_task callbacks,
+    # and invokes the task.
+    #
+    # @param [Class] task The Evoke::Task class to invoke.
+    # @param [Array] *arguments The arguments to invoke the task with.
+    def invoke(task, *arguments)
+      task.validate_arguments(arguments)
+      task = task.new
+      Evoke.call_before_hooks(task, *arguments)
+      task.invoke(*arguments)
+    end
+
+    protected
+
+    # Executes the before callbacks.
+    #
+    # @param [Evoke::Task] task The task instance that is being invoked.
+    # @param [Array] args The arguments that are being passed to the task.
+    def call_before_hooks(task, *args)
+      Array(@before_hooks).each {|hook| hook.call(*args) }
+    end
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: evoke
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Travis Haynes
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.5.1
+description: 
+email:
+- travis@hi5dev.com
+executables:
+- evoke
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- evoke.gemspec
+- exe/evoke
+- lib/evoke.rb
+- lib/evoke/cli.rb
+- lib/evoke/inflections.rb
+- lib/evoke/inflections/camelize.rb
+- lib/evoke/inflections/underscore.rb
+- lib/evoke/task.rb
+- lib/evoke/version.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A build tool for Ruby.
+test_files: []