thor-cheese 0.1.0

data/.document

@@ -0,0 +1,6 @@
+README.rdoc
+lib/thor-cheese.rb
+lib/thor-cheese/ui.rb
+
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Christocracy
+
+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.rdoc

@@ -0,0 +1,90 @@
+= Cheese
+
+A simple {Thor-based}[http://github.com/wycats/thor] Mixin and console-application skeleton.  The structure was inspired by Bundler[http://github.com/carlhuda/bundler].  Cheese provides a colourful UI Shell.  
+
+= Usage
+
+It's very simple to create a Cheese-based console application.  First create an executable in your Gem's <tt>/bin</tt> directory:
+
+	#!/usr/local/bin/ruby
+
+	$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+
+	require 'cheese'
+	require 'your-app'
+	require 'your-app/cli'
+
+	begin
+	  YourApp::CLI.start
+	rescue YourApp::Error => e
+	  YourApp.ui.error e.message
+	  exit e.status_code
+	end
+
+Next, in your Gem's base Module, eg: <tt>lib/your-app.rb</tt>, include the <tt>Cheese</tt> mixin and implement your <tt>Cheese::Error</tt> extensions. 
+	
+	module YourApp
+	  VERSION = "0.1.0"
+
+	  ##
+	  # include the Cheese module into your base nameespace.  This allows you to boot an 
+	  # instance of the colourful Cheese::UI::Sheel
+	  #
+	  include Cheese
+
+		# Do your autoloads here.
+		autoload :MightyGenerator, 'your-app/mighty-generator'
+		
+	  ##
+	  # Example error-extension
+	  #
+	  class Error  < Cheese::Error; status_code(666) ; end
+
+	end
+
+Finally, place your Thor[http://github.com/wycats/thor] extension in your Gem's base-package, eg: <tt>lib/your-app/cli.rb</tt>.  Override the constructor
+and send the shell into the class-method <tt>shell</tt> mixed-in with <tt>include Cheese</tt> in the previous step.
+
+	##
+	# Example Thor instance
+	#
+	module YourApp
+	  class CLI < Thor
+
+	    desc "say", "Say cheese and receive"
+	    def say(word)
+	      if word == 'cheese'
+	        YourApp.ui.confirm("CHEESE!")
+	      else
+	        YourApp.ui.warn(" '#{word}'??  No cheese for you :(")
+	      end
+	    end
+
+	    ##
+	    # For your convenience, override initialize and boot an instance of XCLI::UI::Shell by sending your
+	    # shell method mixed-in by Cheese.
+	    # YourApp.ui.confirm("That was good cheese")
+	    # YourApp.ui.warn("That's stinky cheese")
+	    # YourApp.ui.error("That was horrible cheese")
+	    #
+	    def initialize(*)
+	      YourApp.shell = shell
+	      super
+	    end
+	  end
+	end
+
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Christocracy. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "thor-cheese"
+    gem.summary = %Q{General Thor extension for building console-based ruby apps.  Has built-in colour UI}
+    gem.description = %Q{General Thor extension for building console-based ruby apps with built-in colour UI}
+    gem.email = "christocracy@gmail.com"
+    gem.homepage = "http://github.com/christocracy/thor-cheese"
+    gem.authors = ["Christocracy"]
+    gem.add_dependency "thor", ">=0.13.0"
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+#require 'rake/rdoctask'
+#Rake::RDocTask.new do |rdoc|
+#  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+#  rdoc.rdoc_dir = 'rdoc'
+#  rdoc.title = "xcli #{version}"
+#  rdoc.rdoc_files.include('README*')
+#  rdoc.rdoc_files.include('lib/thor-cheese.rb', 'lib/thor-cheese/ui.rb')
+#end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/thor-cheese

@@ -0,0 +1,14 @@
+#!/usr/local/bin/ruby
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'thor-cheese'
+require 'your-app'
+require 'your-app/cli'
+
+begin
+  YourApp::CLI.start
+rescue YourApp::Error => e
+  YourApp.ui.error e.message
+  exit e.status_code
+end

data/lib/thor-cheese.rb

@@ -0,0 +1,44 @@
+require 'thor'
+class Thor
+  module Cheese
+    VERSION = "0.1.0"
+  
+    autoload :UI,   'thor-cheese/ui'
+  
+    ##
+    # Generic class to build your own error-extensions from.  Copied from Bundler
+    #
+    class Error < StandardError
+      def self.status_code(code = nil)
+        return @code unless code
+        @code = code
+      end
+
+      def status_code
+        self.class.status_code
+      end
+    end
+  
+    ##
+    # Example error-extension
+    #
+    class ArgumentError  < Error; status_code(666) ; end
+  
+    class << self
+      def included(klass)
+        klass.send(:extend, ClassMethods)
+      end
+    end
+  
+    module ClassMethods  
+    
+      def shell=(shell)
+        @ui ||= UI::Shell.new(shell)
+      end
+    
+      def ui
+        @ui ||= UI.new
+      end
+    end
+  end
+end

data/lib/thor-cheese/ui.rb

@@ -0,0 +1,57 @@
+class Thor
+  module Cheese
+    class UI
+      def warn(message)
+      end
+
+      def error(message)
+      end
+
+      def info(message)
+      end
+
+      def confirm(message)
+      end
+
+      class Shell < UI
+        def initialize(shell)
+          @shell = shell
+        end
+        
+        # TODO: Add debug mode
+        def debug(msg)
+        end
+
+        def info(msg)
+          @shell.say(msg)
+        end
+
+        def confirm(msg)
+          @shell.say(msg, :green)
+        end
+
+        def warn(msg)
+          @shell.say(msg, :yellow)
+        end
+
+        def error(msg)
+          @shell.say(msg, :red)
+        end
+      end
+
+      class RGProxy < Gem::SilentUI
+        def initialize(ui)
+          @ui = ui
+        end
+
+        def say(message)
+          if message =~ /native extensions/
+            @ui.info "with native extensions "
+          else
+            @ui.debug(message)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/your-app.rb

@@ -0,0 +1,15 @@
+module YourApp #:nodoc: all
+  VERSION = "0.1.0"
+  
+  ##
+  # mix the ThorCheese module into your base nameespace.  This allows you to boot an 
+  # instance of the colourful Cheese::UI::Sheel
+  #
+  include Thor::Cheese
+  
+  ##
+  # Example error-extension
+  #
+  class Error < Thor::Cheese::Error; status_code(666) ; end
+  
+end

data/lib/your-app/cli.rb

@@ -0,0 +1,36 @@
+##
+# Example Thor instance
+#
+module YourApp
+  class CLI < Thor
+    
+    desc "say", "Say cheese and receive"
+    def say(word)
+      if word == 'cheese'
+        YourApp.ui.confirm("CHEESE!")
+        YourApp.ui.warn("------ --  -- ------ ------ ------ ------")
+        YourApp.ui.warn("--     --  -- --     --     --     --")
+        YourApp.ui.warn("--     ------ ----   ----   ------ ----")
+        YourApp.ui.warn("--     --  -- --     --         -- --")
+        YourApp.ui.warn("------ --  -- ------ ------ ------ ------")
+        
+      else
+        YourApp.ui.error("------------------------------------------")
+        YourApp.ui.error("\"#{word}\"??  No cheese for you :(")
+        YourApp.ui.error("------------------------------------------")
+      end
+    end
+  
+    ##
+    # For your convenience, override initialize and boot an instance of XCLI::UI::Shell by sending your
+    # shell method mixed-in by Cheese.
+    # YourApp.ui.confirm("That was good cheese")
+    # YourApp.ui.warn("That's stinky cheese")
+    # YourApp.ui.error("That was horrible cheese")
+    #
+    def initialize(*)
+      YourApp.shell = shell
+      super
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'xcli'
+
+class Test::Unit::TestCase
+end

data/test/test_xcli.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestXcli < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/thor-cheese.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{thor-cheese}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Christocracy"]
+  s.date = %q{2010-03-11}
+  s.default_executable = %q{thor-cheese}
+  s.description = %q{General Thor extension for building console-based ruby apps with built-in colour UI}
+  s.email = %q{christocracy@gmail.com}
+  s.executables = ["thor-cheese"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "bin/thor-cheese",
+     "lib/thor-cheese.rb",
+     "lib/thor-cheese/ui.rb",
+     "lib/your-app.rb",
+     "lib/your-app/cli.rb",
+     "test/helper.rb",
+     "test/test_xcli.rb",
+     "thor-cheese.gemspec"
+  ]
+  s.homepage = %q{http://github.com/christocracy/thor-cheese}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{General Thor extension for building console-based ruby apps.  Has built-in colour UI}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_xcli.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<thor>, [">= 0.13.0"])
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thor>, [">= 0.13.0"])
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thor>, [">= 0.13.0"])
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification 
+name: thor-cheese
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Christocracy
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-11 00:00:00 -05:00
+default_executable: thor-cheese
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 13
+        - 0
+        version: 0.13.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: General Thor extension for building console-based ruby apps with built-in colour UI
+email: christocracy@gmail.com
+executables: 
+- thor-cheese
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/thor-cheese
+- lib/thor-cheese.rb
+- lib/thor-cheese/ui.rb
+- lib/your-app.rb
+- lib/your-app/cli.rb
+- test/helper.rb
+- test/test_xcli.rb
+- thor-cheese.gemspec
+has_rdoc: true
+homepage: http://github.com/christocracy/thor-cheese
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: General Thor extension for building console-based ruby apps.  Has built-in colour UI
+test_files: 
+- test/helper.rb
+- test/test_xcli.rb