bini 0.5.5 → 0.6.0

data/.gitignore

@@ -2,3 +2,4 @@ Gemfile.lock
 pkg/
 tmp/
 *.tmp
+coverage/

data/.rspec

@@ -1,2 +1,2 @@
 --color
---format progress
+--format documentation

data/.yardopts

@@ -0,0 +1 @@
+--no-private - LICENSE.txt CHANGELOG.md

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# 0.6.0
+* renamed Bini.config to Bini::Config
+* 100% test coverage.
+* Documentation push.
+* Dropped the daemonize code, will implement again later if I decide I need it.
+* Dropped kruft like Bini#get_var
+* Bini.version works as intended, providing a settable version to use in a given app.
+* Options.parse! now takes an ARGV or falls back if nothing is provided.

data/Gemfile

@@ -15,9 +15,11 @@ group :development do
 	gem 'rb-inotify', :require => false
   gem 'rb-fsevent', :require => false
   gem 'rb-fchange', :require => false
+  gem 'redcarpet',  :require => false
 end
 
 group :test do
 	gem "rspec"
 	gem "rake"
+	gem 'simplecov'
 end

data/Guardfile

@@ -12,7 +12,8 @@ guard :rspec do
   watch(%r{^lib/(.+)\.rb$}) { |m| "spec/lib/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')      { "spec" }
 end
-
-# guard :yard do
-#   watch(%r{^lib/(.+)\.rb$})
-# end
+group :docs do
+  guard :yard do
+    watch(%r{^lib/(.+)\.rb$})
+  end
+end

data/README.md

@@ -2,7 +2,7 @@
 
 A toolbox to help me rapidly build/deploy a cli.  Filled with assumptions about how I think a CLI should behave.
 
-#### Build Status
+## Build Status
 <table border="0">
   <tr>
     <td>master</td>
@@ -50,10 +50,6 @@ Generated documentation is available via ```yard```.
 
 Examples and wiki coming if they are ever needed.
 
-## Testing
-
-In theory, testing is complete, in practice it's a work in progress.
-
 ## Design philosophy
 
 If such a thing can be said.
@@ -69,3 +65,4 @@ If such a thing can be said.
 I don't have rules here, more guidelines.
 
 * Try to make the branch name clear, words like feature/issue/bug help.
+* Tests.

data/lib/bini.rb

@@ -4,9 +4,24 @@ require "bini/sash"
 require "bini/version"
 require "bini/filemagic"
 
+# A collection of very small helpers that assist me in writing a CLI without
+# getting in the way.
+#
+# Provides some dynamic attributes, they all behave the same and just hook into
+# the defaults to provide non-nil results when needed.
+#
+# @!attribute long_name [rw]
+#  @return [String] An application name, useful if your app is named differently then your binary.
+# @!attribute cache_dir [rw]
+#  @return [String] The directory to store any cache related files.
+# @!attribute config_dir [rw]
+#  @return [String] The directory to store any config related files.
+# @!attribute version [rw]
+#  @return [String] The version of the application, not of Bini.
 module Bini
   extend self
 
+  # A collection of sane defaults to be provided if the same attr is still nil.
   attr_accessor :defaults
 
   # I break this out so that I can use long name right away, this allows methods
@@ -19,51 +34,20 @@ module Bini
 
   # Dynamic attribute's based off the keys.
   def keys
-    [:long_name, :cache_dir, :config_dir]
+    keys ||= [:long_name, :cache_dir, :config_dir, :version]
   end
 
   keys.each do |key|
     define_method(key) do
       v = instance_variable_get "@#{key}"
-      return @defaults[key] if !v
-      return v
+      return !v ? @defaults[key] : v
     end
     define_method("#{key}=".to_sym) do |dir|
       instance_variable_set "@#{key}", dir
     end
   end
 
-  def pids
-    a = Sys::ProcTable.ps.select{|x| x.cmdline =~ /.*#{@name}.*-[dD].*/}.map {|x| x.pid}
-    a.delete $$
-    return a if a.any?
-    nil
-  end
-
-
-  def daemonize(*params, &block)
-    if params[0] && !params[0][:multiple_pids] && pids
-      puts :info, "#{@name} appears to be running (#{pids}), only one allowed, exiting."
-      exit
-    end
-    puts :info, "Forking to background."
-
-    Process.daemon
-    block.call
-  end
-
-  def kill_daemon
-    if !pids
-      puts :fatal, "No pids found, exiting."
-    end
-
-    pids.each do |p|
-      puts :info, "Killing #{p}"
-      `kill -TERM #{p}`
-    end
-  end
-
-  # Adds a rails style configure method (@benwoody's unknown contribution)
+  # Adds a rails style configure method.
   def configure
     yield self
     parameters
@@ -77,16 +61,9 @@ module Bini
   end
   alias_method :params, :parameters
 
-  # Returns true or false if all parameters are set.
+  # Returns true or false if all parameters are set to something other than defaults.
   def parameters?
-    parameters.values.all?
-  end
-
-  private
-
-  # Helper to clean up recursive method in #parameters
-  def get_var(var)
-    self.instance_variable_get(var)
+    @defaults.map {|k,v| @defaults[k] != parameters[k]}.all?
   end
 end
 

data/lib/bini/config.rb

@@ -1,9 +1,8 @@
 require 'fileutils'
 
 module Bini
-  attr_accessor :config
-
   extend self
 
-  self.config = Sash.new file:"#{Bini.config_dir}/#{Bini.name}.yaml"
+  # A helper for storing configuration related data in.
+  Config = Sash.new file:"#{Bini.config_dir}/#{Bini.name}.yaml"
 end

data/lib/bini/filemagic.rb

@@ -1,7 +1,12 @@
 module Bini
+  # A collection of helpers related to file management.
   module FileMagic
     extend self
 
+    # Call the system app 'file' to check mimetype.
+    # @param [String] file name of the file.
+    # @return [String] of the mimetypes found
+    # @return [Nil] if nothing worked.
     def mime_type(file)
       return `file -bk --mime-type "#{file}"`.chomp! if File.exist? file
       return nil

data/lib/bini/mixins.rb

@@ -1,4 +1,6 @@
+# A mixin for [Array]
 class Array
+  # Return a random element from the Array.
 	def rand
 		self[Random.rand(self.count)]
 	end

data/lib/bini/optparser.rb

@@ -1,6 +1,8 @@
 require 'optparse'
 
 module Bini
+  # An extension of [OptionParser] that behaves like a hash, with saving, loading, and
+  # mashing in other hashs.
   class OptionParser < ::OptionParser
     def initialize
       super
@@ -9,33 +11,33 @@ module Bini
       on("-V", "--version", "Print version") { |version| @options[:version] = true}
     end
 
-    def parse!
+    # Parse out ARGV, includes a catch for returning version, otherwise just calls super.
+    def parse!(*argv)
       super
 
-      if @options[:version]
-        if Bini.version
-          puts Bini.version
-        else
-          puts "No version supplied."
-        end
-        exit 0
+      if Options[:version] && Bini.version
+        puts Bini.version
+        # don't exit if RSpec is around, we are in a testing environment.
+        exit 0 if !Object.constants.include? :RSpec
       end
-
-      mash Bini.config if Bini.config
     end
-
     # These are the hash like bits.
 
+    # Clear the contents of the builtin Hash.
     def clear
       @options.clear
     end
 
-    def [](k = nil)
-      return @options[k] if k
+    # Get results from the builtin in Hash.
+    # @param [Symbol,String,nil] key Either a single key or nil for the entire hash.
+    # @return [Hash] a hash, empty or otherwise.
+    def [](key = nil)
+      return @options[key] if key
       return @options if @options.any?
       {}
     end
 
+    # Set a key/value pair in the buildin Hash.
     def []=(k,v)
       @options[k] = v
     end
@@ -48,6 +50,8 @@ module Bini
       h.each {|k,v| self[k] = v}
     end
   end
-  Options = OptionParser.new
+  # An automatically created entry point into the OptionParser class.
+  Options = Bini::OptionParser.new
 end
 
+

data/lib/bini/prompts.rb

@@ -1,5 +1,3 @@
-# This is originally from: https://gist.github.com/2040373
-
 module Bini
   # A few prompts I may need in making CLI's.
   module Prompts
@@ -22,4 +20,3 @@ module Bini
     end
   end
 end
-

data/lib/bini/sash.rb

@@ -12,8 +12,6 @@ module Bini
     attr_accessor :auto_load
     attr_accessor :auto_save
 
-
-
     # initialization sets the values of the class Sash, not the contents of the Hash.
     def initialize(params = {})
       params.each { |k,v| instance_variable_set "@" + k.to_s,v}
@@ -47,7 +45,7 @@ module Bini
       end
       true
     end
-
+    # Store a value in the Hash.  Can autosave.
     def []=(key,value)
       store key, value
       save! if @auto_save == true

data/lib/bini/version.rb

@@ -1,3 +1,4 @@
 module Bini
-  VERSION = "0.5.5"
+  # The current version of Bini.
+  VERSION = "0.6.0"
 end

data/spec/{config_spec.rb → lib/bini/config_spec.rb}

@@ -2,14 +2,14 @@ require 'spec_helper'
 
 describe "Bini.config" do
 	it "is a hash." do
-		Bini.config.kind_of?(Hash).should be_true
+		Bini::Config.kind_of?(Hash).should be_true
 	end
 
 	it "which responds to save" do
-		Bini.config.respond_to?(:save).should be_true
+		Bini::Config.respond_to?(:save).should be_true
 	end
 
 	it "which responds to load" do
-		Bini.config.respond_to?(:load).should be_true
+		Bini::Config.respond_to?(:load).should be_true
 	end
 end

data/spec/{filemagic_spec.rb → lib/bini/filemagic_spec.rb}

@@ -4,4 +4,8 @@ describe "FileMagic" do
 	it "it will return a ruby mime type when targeting a ruby file." do
 		Bini::FileMagic.mime_type("./lib/bini.rb").should eq "text/x-ruby"
 	end
+  it "will return the version of file if needed" do
+    s = Bini::FileMagic.module_exec {filemagic_version}
+    `file -v`.include?(s).should be_true
+  end
 end

data/spec/{optparser_spec.rb → lib/bini/optparser_spec.rb}

@@ -39,13 +39,17 @@ describe "optparser" do
 			Options.mash h
 			Options[:mash].should eq 'mush'
 		end
-
 	end
 	describe "parse" do
 		it "will attempt to mash in the Config[]#hash if available." do
-			Bini::config[@key] == @value
+			Bini::Config[@key] == @value
 			Options.parse!
 			Options[@key] = @value
 		end
+		it "Will echo the version set by Bini.version" do
+			Bini.version = "v0.0.0"
+			$stdout.should_receive(:puts).with(Bini.version)
+			Options.parse ["-V"]
+		end
 	end
 end

data/spec/lib/bini_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+# I'm not 100% sure convinvced any of these do what I think they do.
+describe "Bini" do
+	before (:each) do
+		Bini.long_name = nil
+		@long_name = Bini.long_name
+		Bini.cache_dir = nil
+		@cache_dir = Bini.cache_dir
+		Bini.config_dir = nil
+		@config_dir = Bini.config_dir
+		Bini.version = nil
+	end
+
+	describe "parameters?" do
+		it 'will return true only if everything is true.' do
+			Bini.long_name = "tmp/test"
+			Bini.parameters?.should be_false
+			Bini.cache_dir = "tmp/here"
+			Bini.config_dir = "tmp/there"
+			Bini.parameters?.should be_true
+		end
+	end
+
+	# Dynamically generate our key tests, more for fun then any real need.
+	Bini.keys.each do |key|
+		describe "#{key}" do
+			it "can be reset to a default" do
+				Bini.send "#{key}=", nil
+				Bini.send(key).should eq Bini.defaults[key]
+			end
+			it "can be overriden" do
+				r = random_hex 16
+				Bini.send "#{key}=", r
+				Bini.send(key).should eq r
+			end
+
+			it "can be configured via .configure" do
+				r = random_hex 4
+				Bini.configure do |c|
+					c.instance_variable_set "@#{key}", r
+				end
+				Bini.send(key).should eq r
+			end
+		end
+	end
+
+	Bini.version
+end
+

data/spec/spec_helper.rb

@@ -1,3 +1,8 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter "/spec/"
+end
+
 require 'bini'
 require 'bini/optparser'
 require 'bini/config'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bini
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-06 00:00:00.000000000 Z
+date: 2012-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sys-proctable
@@ -37,6 +37,8 @@ files:
 - .gitignore
 - .rspec
 - .travis.yml
+- .yardopts
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -51,12 +53,12 @@ files:
 - lib/bini/prompts.rb
 - lib/bini/sash.rb
 - lib/bini/version.rb
-- spec/bini_spec.rb
-- spec/config_spec.rb
-- spec/filemagic_spec.rb
-- spec/mixins_spec.rb
-- spec/optparser_spec.rb
-- spec/sash_spec.rb
+- spec/lib/bini/config_spec.rb
+- spec/lib/bini/filemagic_spec.rb
+- spec/lib/bini/mixins_spec.rb
+- spec/lib/bini/optparser_spec.rb
+- spec/lib/bini/sash_spec.rb
+- spec/lib/bini_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/erniebrodeur/bini
 licenses: []
@@ -70,18 +72,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -581091682006893014
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -581091682006893014
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.21
@@ -91,11 +87,11 @@ summary: Bini is a gem that helps me build CLI tools.  It's not thor, trollop, o
   any of the other major frameworks.  It makes lots and lots of assumptions.  It's
   probably not for you.
 test_files:
-- spec/bini_spec.rb
-- spec/config_spec.rb
-- spec/filemagic_spec.rb
-- spec/mixins_spec.rb
-- spec/optparser_spec.rb
-- spec/sash_spec.rb
+- spec/lib/bini/config_spec.rb
+- spec/lib/bini/filemagic_spec.rb
+- spec/lib/bini/mixins_spec.rb
+- spec/lib/bini/optparser_spec.rb
+- spec/lib/bini/sash_spec.rb
+- spec/lib/bini_spec.rb
 - spec/spec_helper.rb
 has_rdoc: 

data/spec/bini_spec.rb

@@ -1,92 +0,0 @@
-require 'spec_helper'
-
-# I'm not 100% sure convinvced any of these do what I think they do.
-describe "Bini" do
-	before (:each) do
-		Bini.long_name = nil
-		@long_name = Bini.long_name
-		Bini.cache_dir = nil
-		@cache_dir = Bini.cache_dir
-		Bini.config_dir = nil
-		@config_dir = Bini.config_dir
-	end
-
-	# I can probably do this dynamically.
-	describe "long_name" do
-		it "can be reset" do
-			Bini.long_name = nil
-			Bini.long_name.should eq Bini.defaults[:long_name]
-		end
-
-		it "provides a default" do
-			Bini.long_name = nil
-			Bini.long_name.should_not be_nil
-		end
-
-		it "can be overridden" do
-			r = random_hex 4
-			Bini.long_name = r
-			Bini.long_name.should eq r
-		end
-
-		it "can be configured via .configure" do
-			r = random_hex 4
-			Bini.configure do |c|
-				c.long_name = r
-			end
-			Bini.long_name.should eq r
-		end
-	end
-
-	describe "cache_dir" do
-		it "can be reset" do
-			Bini.cache_dir = nil
-			Bini.cache_dir.should eq @cache_dir
-		end
-
-
-		it "provides a default" do
-			Bini.cache_dir = nil
-			Bini.cache_dir.should_not be_nil
-		end
-
-		it "can be overridden" do
-			r = random_hex 4
-			Bini.cache_dir = r
-			Bini.cache_dir.should eq r
-		end
-		it "can be configured via .configure" do
-			r = random_hex 4
-			Bini.configure do |c|
-				c.cache_dir = r
-			end
-			Bini.cache_dir.should eq r
-		end
-	end
-	describe "config_dir" do
-		it "can be reset" do
-			Bini.config_dir = nil
-			Bini.config_dir.should eq @config_dir
-		end
-
-
-		it "provides a default" do
-			Bini.config_dir = nil
-			Bini.config_dir.should_not be_nil
-		end
-
-		it "can be overridden" do
-			r = random_hex 4
-			Bini.config_dir = r
-			Bini.config_dir.should eq r
-		end
-		it "can be configured via .configure" do
-			r = random_hex 4
-			Bini.configure do |c|
-				c.config_dir = r
-			end
-			Bini.config_dir.should eq r
-		end
-	end
-end
-