valet 0.0.5 → 0.0.6

data/.travis.yml

@@ -6,11 +6,6 @@ rvm:
   - rbx
   - jruby
 
-matrix:
-  allow_failures:
-    - rvm: rbx
-    - rvm: jruby
-
 branches:
   only:
     - master

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Valet - CHANGELOG
 
+### 0.0.6 / 08.07.2012
+
+* New GNU compliant feature: "Version"
+* Basic Mustache views and templates integration
+* Postponed Valet's own CLI in favor of creating a general API first
+* Minor improvements to the development and testing environment
+* Refactored features and step definitions
+* New skeleton feature for next iteration: "Help"
+
 ### 0.0.5 / 06.07.2012
 
 * Allowed jruby and rbx to fail a build on Travis

data/Guardfile

@@ -4,7 +4,8 @@ guard 'rspec', all_on_start: false, all_after_pass: false do
   watch('spec/spec_helper.rb')  { 'spec' }
 end
 
-guard 'cucumber', all_on_start: false, all_after_pass: false do
+guard 'cucumber', all_on_start: false, all_after_pass: false,
+  cli: '--format progress --color --strict --tags ~@wip' do
   watch(%r{features/.+\.feature$})
   watch(%r{^features/support/.+$}) { 'features' }
   watch(%r{^features/step_definitions/(.+)_steps\.rb$}) do |m|

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.5  
-__Release Date__:   06.07.2012  
+__Latest Version__: 0.0.6  
+__Release Date__:   08.07.2012  
 
 ## Introduction
 

data/bin/valet

@@ -1,5 +1 @@
 #!/usr/bin/env ruby
-
-require 'valet/cli'
-
-Valet::CLI.start

data/features/help.feature

@@ -0,0 +1,39 @@
+@wip
+Feature: Help (--help)
+
+  In order to get standard help on how to use the application
+  As a software developer and user of the application
+  I want to print out its usage with syntax, description, examples, available
+  global options and commands
+
+    Usage: ls [OPTION]... [FILE]...
+    List information about the FILEs (the current directory by default).
+    Sort entries alphabetically if none of -cftuvSUX nor --sort is specified.
+
+    Mandatory arguments to long options are mandatory for short options too.
+      -a, --all                do not ignore entries starting with .
+      -A, --almost-all         do not list implied . and ..
+          --author             with -l, print the author of each file
+      -b, --escape             print C-style escapes for nongraphic characters
+          --block-size=SIZE    scale sizes by SIZE before printing them.  E.g.,
+                                 '--block-size=M' prints sizes in units of
+                                 1,048,576 bytes.  See SIZE format below.
+
+                                    (...)
+
+    Report ls bugs to bug-coreutils@gnu.org
+    GNU coreutils home page: <http://www.gnu.org/software/coreutils/>
+    General help using GNU software: <http://www.gnu.org/gethelp/>
+    For complete documentation, run: info coreutils 'ls invocation'
+
+  GNU Coding Standards:
+  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: List of examples
+  Scenario: Available global options
+  Scenario: Available sub-commands
+  Scenario: Bug reporting address
+  Scenario: Application homepage
+  Scenario: Other commands, options and operands are ignored

data/features/step_definitions/command_line_steps.rb

@@ -0,0 +1,3 @@
+When /^I successfully run the script `([^`]*)`$/ do |script|
+  run_simple("ruby -S #{unescape(script)}")
+end

data/features/step_definitions/file_steps.rb

@@ -0,0 +1,3 @@
+Given /^a Valet application named "([^"]*)" with:$/ do |file_name, file_content|
+  write_file(file_name, new_cli(file_content).source)
+end

data/features/support/helpers/cli_helper.rb

@@ -0,0 +1,23 @@
+module CLIHelper
+  class CLI
+    def initialize(content = nil)
+      @content = content
+    end
+
+    def source
+      <<-CLI_FILE.gsub(/^ {8}/, '')
+        require 'valet'
+
+        class CLI < Valet::Application
+        #{@content ? @content.gsub(/^/, '  ') : '# No content has been given'}
+        end
+
+        CLI.start
+      CLI_FILE
+    end
+  end
+
+  def new_cli(content = nil)
+    CLI.new(content)
+  end
+end

data/features/support/world_extensions.rb

@@ -0,0 +1 @@
+World(CLIHelper)

data/features/version.feature

@@ -1,32 +1,118 @@
-Feature: Version
+Feature: Version (--version)
 
-  In order to check Valet's version and legal information
-  As a software developer
+  In order to check an application's version and legal information
+  As a software developer and user of the application
   I want to print out its version summary
 
-  A version summary may look like this:
+  A complete version summary may look like this:
 
     Valet 1.2.3
     Copyright (c) 2012 Alexander Baumann
     License: <http://www.opensource.org/licenses/MIT> MIT License
 
+    Written by Alexander Baumann
+
   GNU Coding Standards:
   http://www.gnu.org/prep/standards/standards.html#g_t_002d_002dversion
 
-  Scenario: Print out version summary
-    When I successfully run `valet --version`
-    Then the output should match:
+  Scenario: Print out application name
+    Given a Valet application named "name.rb" with:
       """
-      Valet \d+\.\d+\.\d+(\.rc\d+)?
-      Copyright \(c\) \d{4}(-\d{4})? Alexander Baumann
-      License: <http://www\.opensource\.org/licenses/MIT> MIT License
+      self.name = 'Backup'
       """
+    When I successfully run the script `name.rb --version`
+    Then the stdout should contain "Backup"
 
-  Scenario: Other commands, options and operands are ignored
-    When I successfully run `valet command --option operand --version`
-    Then the output should match:
+  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
       """
-      Valet \d+\.\d+\.\d+(\.rc\d+)?
-      Copyright \(c\) \d{4}(-\d{4})? Alexander Baumann
-      License: <http://www\.opensource\.org/licenses/MIT> MIT 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: Other commands, options and operands are ignored

data/lib/valet.rb

@@ -21,5 +21,9 @@
 # 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'

data/lib/valet/application.rb

@@ -1,11 +1,22 @@
 module Valet
-  module Application
-    attr_accessor :name, :version, :copyright, :license
+  class Application
+    class << self
+      attr_accessor :name, :version, :authors, :copyright, :license
 
-    def start
-      puts "#{name} #{version}"
-      puts "#{copyright}"
-      puts "#{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
     end
   end
 end

data/lib/valet/templates/version.mustache

@@ -0,0 +1,5 @@
+{{name}} {{version}}
+{{copyright}}
+{{license}}
+
+{{authors}}

data/lib/valet/version.rb

@@ -2,7 +2,7 @@ module Valet
   module VERSION
     MAJOR = 0
     MINOR = 0
-    BUILD = 5
+    BUILD = 6
     PRE   = nil
 
     STRING = [MAJOR, MINOR, BUILD, PRE].compact.join('.')

data/lib/valet/view.rb

@@ -0,0 +1,29 @@
+module Valet
+  class View < Mustache
+    self.view_namespace = 'Valet::Views'
+    self.template_path = 'templates'
+
+    def render
+      fall_back_to_valet unless template_exists?
+      super
+    end
+
+    def escapeHTML(string)
+      string
+    end
+
+    private
+
+    def fall_back_to_valet
+      self.template_path = valet_template_path
+    end
+
+    def valet_template_path
+      File.expand_path('../templates', __FILE__)
+    end
+
+    def template_exists?
+      File.exists?(template_file)
+    end
+  end
+end

data/lib/valet/views/version.rb

@@ -0,0 +1,31 @@
+module Valet
+  module Views
+    class Version < View
+      def initialize(application)
+        @app = application
+      end
+
+      def name
+        @app.name
+      end
+
+      def version
+        @app.version
+      end
+
+      def copyright
+        @app.copyright
+      end
+
+      def license
+        @app.license
+      end
+
+      def authors
+        if @app.authors.respond_to?(:join) && @app.authors.count > 0
+          "Written by #{@app.authors.join(', ')}"
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -13,11 +13,16 @@ Dir[File.expand_path('spec/support/**/*.rb')].each { |file| require file }
 
 # Load the application
 require 'valet'
-require 'valet/cli'
-
-# Include the application
 include Valet
 
+# Capture STDOUT and STDIN in new IO streams
+require 'stringio'
+$stdout = StringIO.new
+$stderr = StringIO.new
+
+# Reset ARGV to contain no arguments
+ARGV.clear
+
 # Configure RSpec
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true

data/spec/valet/application_spec.rb

@@ -1,29 +1,52 @@
 require 'spec_helper'
 
 describe Valet::Application do
-  let(:app) { Class.new.extend(Valet::Application) }
+  let(:app) { Application.new }
 
-  it "has a name" do
-    app.name = 'Backup'
-    app.name.should == 'Backup'
-  end
+  describe "class attributes" do
+    it "can have a name" do
+      Application.name = 'Backup'
+      Application.name.should == 'Backup'
+    end
 
-  it "can a version" do
-    app.version = '1.2.3'
-    app.version.should == '1.2.3'
-  end
+    it "can have a version" do
+      Application.version = '1.2.3'
+      Application.version.should == '1.2.3'
+    end
+
+    it "can have authors" do
+      Application.authors = ['Alexander Baumann', 'Bob the Builder']
+      Application.authors.should == ['Alexander Baumann', 'Bob the Builder']
+    end
 
-  it "can have a copyright notice" do
-    app.copyright = 'Copyright (c) 2007 Free Software Foundation, Inc.'
-    app.copyright.should == 'Copyright (c) 2007 Free Software Foundation, Inc.'
+    it "can have a copyright notice" do
+      Application.copyright = 'Copyright (c) 2012 Free Software Foundation, Inc.'
+      Application.copyright.should == 'Copyright (c) 2012 Free Software Foundation, Inc.'
+    end
+
+    it "can have a license" do
+      Application.license = <<-LICENSE.gsub(/^ {6}/, '').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
+      Application.license.should include('GNU GPL version 3 or later')
+    end
   end
 
-  it "can have a license" do
-    app.license = <<-LICENSE.gsub(/^ {6}/, '')
-      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
-    app.license.should include('GNU GPL version 3 or later')
+  describe ".start" do
+    it "passes ARGV as arguments to it's new instance by default" do
+      app = Application.start
+      app.args.should == ARGV
+    end
+
+    it "can pass custom arguments to it's new instance" do
+      app = Application.start(%w( --custom arguments ))
+      app.args.should == %w( --custom arguments )
+    end
+
+    it "returns the new application" do
+      Application.start.should be_an_instance_of(Application)
+    end
   end
 end

data/spec/valet/view_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Valet::View do
+  let(:view) { View.new }
+  let(:mustache) { double("Mustache") }
+
+  describe "#render" do
+    it "creates a new Mustache object and renders it" do
+      Mustache.stub(new: mustache)
+      mustache.stub(render: 'Render output!')
+      view.render.should == 'Render output!'
+    end
+  end
+
+  describe "#escapeHTML" do
+    it "overwrites Mustache's #escapeHTML to not escape at all" do
+      view.escapeHTML('<html>').should == '<html>'
+    end
+  end
+end

data/valet.gemspec

@@ -33,6 +33,8 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(spec|features)/})
   gem.require_paths = ['lib']
 
+  gem.add_dependency 'mustache', '~> 0.99'
+
   gem.add_development_dependency 'rake',          '~> 0.9'
   gem.add_development_dependency 'rspec',         '~> 2.10'
   gem.add_development_dependency 'cucumber',      '~> 1.2'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: valet
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-06 00:00:00.000000000 Z
+date: 2012-07-08 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: mustache
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.99'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.99'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -161,15 +177,23 @@ files:
 - README.md
 - Rakefile
 - bin/valet
+- features/help.feature
+- features/step_definitions/command_line_steps.rb
+- features/step_definitions/file_steps.rb
 - features/support/env.rb
+- features/support/helpers/cli_helper.rb
+- features/support/world_extensions.rb
 - features/version.feature
 - lib/valet.rb
 - lib/valet/application.rb
-- lib/valet/cli.rb
+- lib/valet/templates/version.mustache
 - lib/valet/version.rb
+- lib/valet/view.rb
+- lib/valet/views/version.rb
 - spec/spec_helper.rb
 - spec/valet/application_spec.rb
 - spec/valet/version_spec.rb
+- spec/valet/view_spec.rb
 - tasks/clean.rake
 - tasks/cucumber.rake
 - tasks/spec.rake
@@ -179,7 +203,7 @@ homepage: http://gitkeeper.github.com/valet
 licenses:
 - MIT
 post_install_message: ! "\n# --------------------------------------------------------------------
-  #\n\n    Thank you for installing Valet 0.0.5!\n\n    Valet is still in development
+  #\n\n    Thank you for installing Valet 0.0.6!\n\n    Valet is still in development
   and not yet intended to be used.\n\n# --------------------------------------------------------------------
   #\n\n"
 rdoc_options: []
@@ -193,7 +217,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -599914499916021276
+      hash: 2757034433655035454
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -202,7 +226,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -599914499916021276
+      hash: 2757034433655035454
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -210,9 +234,15 @@ signing_key:
 specification_version: 3
 summary: A framework for creating GNU compliant command-line interfaces.
 test_files:
+- features/help.feature
+- features/step_definitions/command_line_steps.rb
+- features/step_definitions/file_steps.rb
 - features/support/env.rb
+- features/support/helpers/cli_helper.rb
+- features/support/world_extensions.rb
 - features/version.feature
 - spec/spec_helper.rb
 - spec/valet/application_spec.rb
 - spec/valet/version_spec.rb
+- spec/valet/view_spec.rb
 has_rdoc: 

data/lib/valet/cli.rb

@@ -1,12 +0,0 @@
-require 'valet'
-
-module Valet
-  class CLI
-    extend Valet::Application
-
-    self.name = 'Valet'
-    self.version = Valet::VERSION::STRING
-    self.copyright = 'Copyright (c) 2012 Alexander Baumann'
-    self.license = 'License: <http://www.opensource.org/licenses/MIT> MIT License'
-  end
-end