valet 0.0.7 → 0.0.8

data/.travis.yml

@@ -3,13 +3,13 @@ script: "bundle exec rspec spec && bundle exec cucumber features"
 rvm:
   - 1.9.2
   - 1.9.3
-  - rbx
-  - jruby
+  - jruby-19mode
+  - rbx-19mode
 
 matrix:
   allow_failures:
-    - rvm: rbx
-    - rvm: jruby
+    - rvm: jruby-19mode
+    - rvm: rbx-19mode
 
 branches:
   only:

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Valet - CHANGELOG
 
+### 0.0.8 / 11.07.2012
+
+Started over with a new approach, designing business objects and API first
+
+* Made an output notice in bin/valet to notify the user of Valet's current
+  development status
+* Implemented core classes with basic business rules
+  * Application
+  * Command
+  * Options
+  * Option::Switch
+  * Option::Flag
+* New RSpec 'expect' syntax and improved support files to help with testing
+  stdout, stderr and stdin streams
+* Playing around with Travis (JRuby and Rubinius compatibility seems to fail on
+  me because of C-extensions and code coverage...)
+
 ### 0.0.7 / 08.07.2012
 
 * JRuby and Rubinius still won't build successfully on Travis. Allowed them once

data/README.md

@@ -7,8 +7,8 @@ __Git Repository__: <https://github.com/gitkeeper/valet>
 __Author__:         Alexander Baumann  
 __Copyright__:      2012  
 __License__:        MIT License  
-__Latest Version__: 0.0.7  
-__Release Date__:   08.07.2012  
+__Latest Version__: 0.0.8  
+__Release Date__:   11.07.2012  
 
 ## Introduction
 

data/bin/valet

@@ -1 +1,15 @@
 #!/usr/bin/env ruby
+
+require 'valet/version'
+
+puts <<-MESSAGE.gsub(/^ {2}/, '')
+
+  # -------------------------------------------------------------------- #
+
+      Thank you for trying out Valet #{Valet::VERSION::STRING}!
+
+      Valet is still in development and not yet intended to be used.
+
+  # -------------------------------------------------------------------- #
+
+MESSAGE

data/features/help.feature

@@ -30,10 +30,10 @@ Feature: Help (--help)
   http://www.gnu.org/prep/standards/standards.html#g_t_002d_002dhelp
 
   Scenario: Usage and syntax reference
-  Scenario: Short description about the application's purpose
+  Scenario: Short description about Valet's purpose
   Scenario: List of examples
   Scenario: Available global options
-  Scenario: Available sub-commands
+  Scenario: Available (sub-)commands
   Scenario: Bug reporting address
   Scenario: Application homepage
   Scenario: Other commands, options and operands are ignored

data/features/version.feature

@@ -1,10 +1,11 @@
+@wip
 Feature: Version (--version)
 
-  In order to check an application's version and legal information
-  As a software developer and user of the application
+  In order to check Valet's version and legal information
+  As a software developer and user of Valet
   I want to print out its version summary
 
-  A complete version summary may look like this:
+  The version summary should look like this:
 
     Valet 1.2.3
     Copyright (c) 2012 Alexander Baumann
@@ -15,104 +16,5 @@ Feature: Version (--version)
   GNU Coding Standards:
   http://www.gnu.org/prep/standards/standards.html#g_t_002d_002dversion
 
-  Scenario: Print out application name
-    Given a Valet application named "name.rb" with:
-      """
-      self.name = 'Backup'
-      """
-    When I successfully run the script `name.rb --version`
-    Then the stdout should contain "Backup"
-
-  Scenario: Print out application name and version
-    Given a Valet application named "name_and_version.rb" with:
-      """
-      self.name = 'Backup'
-      self.version = '1.2.3'
-      """
-    When I successfully run the script `name_and_version.rb --version`
-    Then the stdout should contain "Backup 1.2.3"
-
-  Scenario: Print out authors
-    Given a Valet application named "authors.rb" with:
-      """
-      self.authors = ['Alexander Baumann', 'Bob the Builder']
-      """
-    When I successfully run the script `authors.rb --version`
-    Then the stdout should contain:
-      """
-      Written by Alexander Baumann, Bob the Builder
-      """
-
-  Scenario: Print out copyright notice
-    Given a Valet application named "copyright.rb" with:
-      """
-      self.copyright = 'Copyright (c) 2012 Free Software Foundation, Inc.'
-      """
-    When I successfully run the script `copyright.rb --version`
-    Then the stdout should contain:
-      """
-      Copyright (c) 2012 Free Software Foundation, Inc.
-      """
-
-  Scenario: Print out legal status
-    Given a Valet application named "legal_status.rb" with:
-      """
-      self.license = <<-LICENSE.gsub(/^ {4}/, '').strip
-        License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
-        This is free software: You are free to change and redistribute it.
-        There is NO WARRANTY, to the extent permitted by law.
-      LICENSE
-      """
-    When I successfully run the script `legal_status.rb --version`
-    Then the stdout should contain:
-      """
-      License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
-      This is free software: You are free to change and redistribute it.
-      There is NO WARRANTY, to the extent permitted by law.
-      """
-
-  Scenario: Print out the complete version summary
-    Given a Valet application named "version.rb" with:
-      """
-      self.name      = 'Backup'
-      self.version   = '1.2.3'
-      self.authors   = ['Alexander Baumann', 'Bob the Builder']
-      self.copyright = 'Copyright (c) 2012 Free Software Foundation, Inc.'
-      self.license   = <<-LICENSE.gsub(/^ {4}/, '').strip
-        License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
-        This is free software: You are free to change and redistribute it.
-        There is NO WARRANTY, to the extent permitted by law.
-      LICENSE
-      """
-    When I successfully run the script `version.rb --version`
-    Then the stdout should contain:
-      """
-      Backup 1.2.3
-      Copyright (c) 2012 Free Software Foundation, Inc.
-      License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
-      This is free software: You are free to change and redistribute it.
-      There is NO WARRANTY, to the extent permitted by law.
-
-      Written by Alexander Baumann, Bob the Builder
-      """
-
-  Scenario: Customizable/Overridable version summary template
-    Given a file named "templates/version.mustache" with:
-      """
-      {{name}} {{version}}
-      For more information, please visit http://gitkeeper.github.com/valet
-      """
-    And a Valet application named "custom_version_template.rb" with:
-      """
-      self.name = 'Backup'
-      self.version = '1.2.3'
-      """
-    When I successfully run the script `custom_version_template.rb --version`
-    Then the stdout should contain:
-      """
-      Backup 1.2.3
-      For more information, please visit http://gitkeeper.github.com/valet
-      """
-
-  @wip
+  Scenario: The global `--version` option prints out the summary
   Scenario: Other commands, options and operands are ignored

data/lib/valet.rb

@@ -21,9 +21,10 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-require 'mustache'
-
 require 'valet/version'
 require 'valet/application'
-require 'valet/view'
-require 'valet/views/version'
+require 'valet/command'
+require 'valet/commands'
+require 'valet/option/switch'
+require 'valet/option/flag'
+require 'valet/options'

data/lib/valet/application.rb

@@ -1,22 +1,14 @@
 module Valet
   class Application
-    class << self
-      attr_accessor :name, :version, :authors, :copyright, :license
-
-      def start(args = ARGV)
-        new(args)
-      end
-    end
-
-    attr_reader :args
-
-    def initialize(args)
-      @args = args
-      render_version
-    end
-
-    def render_version
-      puts Views::Version.new(self.class).render.strip
+    attr_reader :arguments, :options, :commands, :examples
+    attr_accessor :name, :version, :authors, :email, :homepage
+    attr_accessor :copyright, :license, :summary, :description
+
+    def initialize(arguments = ARGV)
+      @arguments = arguments
+      @options   = Options.new
+      @commands  = Commands.new
+      @examples  = []
     end
   end
 end

data/lib/valet/command.rb

@@ -0,0 +1,60 @@
+module Valet
+  class Command
+    attr_reader :name, :options, :commands, :examples
+    attr_accessor :aliases, :syntax, :summary, :description
+
+    def initialize(name, &block)
+      validate_name(name)
+      @name     = name
+      @action   = block
+      @options  = Options.new
+      @commands = Commands.new
+      @examples = []
+    end
+
+    def action(&block)
+      if block_given?
+        validate_action(block)
+        @action = block
+      end
+
+      @action
+    end
+
+    def execute(*operands)
+      if action.arity == 0
+        action.call
+      elsif action.arity == 1
+        action.call(options)
+      else
+        action.call(operands, options)
+      end
+    end
+
+    private
+
+    def validate_name(name)
+      unless valid_name?(name)
+        raise CommandError,
+          "Name: '#{name}' must be a symbol"
+      end
+    end
+
+    def valid_name?(name)
+      name.is_a?(Symbol)
+    end
+
+    def validate_action(proc)
+      unless valid_action?(proc)
+        raise CommandError,
+          "Action: '#{action}' may not have more than two block parameters"
+      end
+    end
+
+    def valid_action?(proc)
+      proc.arity <= 2 && proc.arity >= 0
+    end
+  end
+
+  class CommandError < StandardError; end
+end

data/lib/valet/commands.rb

@@ -0,0 +1,7 @@
+require 'set'
+
+module Valet
+  class Commands < Set
+    # Code goes here...
+  end
+end

data/lib/valet/helpers/type_cast.rb

@@ -0,0 +1,46 @@
+module Valet
+  module Helpers
+    module TypeCast
+      ALLOWED_TYPES = [String, Integer, Float, Array, Hash, Time]
+
+      def string_to(type, string)
+        validate_type(type)
+
+        case
+        when type == String then string
+        when type == Integer then string.to_i
+        when type == Float then string.to_f
+        when type == Array then to_array(string)
+        when type == Hash then to_hash(string)
+        when type == Time then Time.parse(string)
+        else type.new(string)
+        end
+      end
+
+      private
+
+      def validate_type(type)
+        unless valid_type?(type)
+          raise TypeError,
+            "'#{type}' must be one of #{ALLOWED_TYPES.join(', ')}"
+        end
+      end
+
+      def valid_type?(type)
+        ALLOWED_TYPES.include?(type)
+      end
+
+      def to_array(string)
+        string.split(/,|\s/)
+      end
+
+      def to_hash(string)
+        string.split(/,|\s/).inject(Hash.new) do |hash, str|
+          key, value = str.split(/:/)
+          hash[key.to_sym] = value
+          hash
+        end
+      end
+    end
+  end
+end

data/lib/valet/option/common.rb

@@ -0,0 +1,58 @@
+module Valet
+  module Option
+    class Common
+      attr_reader :long_name, :short_name
+      attr_accessor :summary, :description
+
+      alias_method :name, :long_name
+
+      def initialize(long_name)
+        validate_long_name(long_name)
+        @long_name = long_name
+      end
+
+      def short_name=(new_short_name)
+        validate_short_name(new_short_name)
+        @short_name = new_short_name
+      end
+
+      def switch?
+        instance_of?(Switch)
+      end
+
+      def flag?
+        instance_of?(Flag)
+      end
+
+      def short_name_to_s
+        "-#{short_name}" if short_name
+      end
+
+      private
+
+      def validate_long_name(long_name)
+        unless valid_long_name?(long_name)
+          raise OptionError,
+            "Long Name: '#{long_name}' must be a symbol and longer than one character"
+        end
+      end
+
+      def valid_long_name?(long_name)
+        long_name.is_a?(Symbol) && long_name.length > 1
+      end
+
+      def validate_short_name(short_name)
+        unless valid_short_name?(short_name)
+          raise OptionError,
+            "Short Name: '#{short_name}' must be a symbol and exactly one character long"
+        end
+      end
+
+      def valid_short_name?(short_name)
+        short_name.is_a?(Symbol) && short_name.length == 1
+      end
+    end
+  end
+
+  class OptionError < StandardError; end
+end

data/lib/valet/option/flag.rb

@@ -0,0 +1,44 @@
+require 'valet/option/common'
+require 'valet/helpers/type_cast'
+
+module Valet
+  module Option
+    class Flag < Common
+      include Helpers::TypeCast
+
+      attr_reader :type, :default, :value
+      attr_writer :arg_name
+
+      def initialize(long_name)
+        super
+        @type = String
+      end
+
+      def type=(new_type)
+        validate_type(new_type)
+        @type = new_type
+      end
+
+      def default=(new_default)
+        @default = new_default
+        @value = @default
+      end
+
+      def value=(new_value)
+        @value = string_to(type, new_value)
+      end
+
+      def arg_name
+        @arg_name or long_name.to_s.gsub(/_/, ' ')
+      end
+
+      def long_name_to_s
+        if default
+          "--#{long_name}[=<#{arg_name}>]".gsub(/_/, '-')
+        else
+          "--#{long_name}=<#{arg_name}>".gsub(/_/, '-')
+        end
+      end
+    end
+  end
+end