bini 0.5.2

data/.gitignore

@@ -0,0 +1,4 @@
+Gemfile.lock
+pkg/
+tmp/
+*.tmp

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,11 @@
+bundler_args: --without development
+
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - rbx-19mode
+
+branches:
+  only:
+    - master
+    - development

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+	gem "pry"
+end
+
+group :test do
+	gem "rspec"
+	gem "rake"
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ernie Brodeur
+
+MIT License
+
+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,71 @@
+# Bini
+
+A toolbox to help me rapidly build/deploy a cli.  Filled with assumptions about how I think a CLI should behave.
+
+#### Build Status
+<table border="0">
+  <tr>
+    <td>master</td>
+    <td><a href=http://travis-ci.org/erniebrodeur/bini?branch=master><img src="https://secure.travis-ci.org/erniebrodeur/bini.png?branch=master"/></h> </td>
+  </tr>
+  <tr>
+    <td>development</td>
+    <td><a href=http://travis-ci.org/erniebrodeur/bini?branch=development><img src="https://secure.travis-ci.org/erniebrodeur/bini.png?branch=development"/></h> </td>
+  </tr>
+</table>
+
+## Installation
+
+To install:
+
+		% gem install bini
+
+To use inside of an application, add this to the your gemfile:
+
+		% gem 'bini'
+
+and run bundle to make it available:
+
+		% bundle
+
+## Usage
+
+Bini is broken up into a few pieces, always include this first:
+
+```ruby
+require 'bini'
+```
+
+Optional components can be loaded like this:
+
+```ruby
+require 'bini/config'
+require 'bini/optparser'
+require 'bini/log'
+```
+
+### API
+
+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.
+
+* Whenever possible, sane defaults will be supplied.
+* A minimum amount of configuration before execution.
+* If it requires a large chunk of requires, put it in a sub gem.
+* Speed is of the utmost importance.
+* Whenever possible, use stuff out of the stdlib.
+
+## Contributing
+
+I don't have rules here, more guidelines.
+
+* Try to make the branch name clear, words like feature/issue/bug help.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+require "bundler/gem_tasks"

data/bini.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bini/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "bini"
+  gem.version       = Bini::VERSION
+  gem.authors       = ["Ernie Brodeur"]
+  gem.email         = ["ebrodeur@ujami.net"]
+  gem.description   = "Bini needs no description."
+  gem.summary       = "Bini is a gem that helps me build CLI tools.  It's not thor, trollop, or any of the other major frameworks.  It makes lots and lots of assumptions.  It's probably not for you."
+  gem.homepage      = "https://github.com/erniebrodeur/bini"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_runtime_dependency "sys-proctable"
+end

data/lib/bini.rb

@@ -0,0 +1,92 @@
+require 'sys/proctable'
+
+require "bini/sash"
+require "bini/version"
+require "bini/filemagic"
+
+module Bini
+  extend self
+
+  attr_accessor :defaults
+
+  # I break this out so that I can use long name right away, this allows methods
+  # like configure to work.
+
+  @defaults = {}
+  @defaults[:long_name] = $0.split("/").last
+  @defaults[:cache_dir] = "#{Dir.home}/.cache/bini/#{@long_name}/"
+  @defaults[:config_dir] = "#{Dir.home}/.config/bini/#{@long_name}/"
+
+  # Dynamic attribute's based off the keys.
+  def keys
+    [:long_name, :cache_dir, :config_dir]
+  end
+
+  keys.each do |key|
+    define_method(key) do
+      v = instance_variable_get "@#{key}"
+      return @defaults[key] if !v
+      return 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)
+  def configure
+    yield self
+    parameters
+  end
+
+  # List available parameters and values in those params
+  def parameters
+    @values = {}
+    keys.each { |k| @values.merge! k => Bini.send(k) }
+    @values
+  end
+  alias_method :params, :parameters
+
+  # Returns true or false if all parameters are set.
+  def parameters?
+    parameters.values.all?
+  end
+
+  private
+
+  # Helper to clean up recursive method in #parameters
+  def get_var(var)
+    self.instance_variable_get(var)
+  end
+end
+

data/lib/bini/config.rb

@@ -0,0 +1,9 @@
+require 'fileutils'
+
+module Bini
+  attr_accessor :config
+
+  extend self
+
+  self.config = Sash.new file:"#{Bini.config_dir}/#{Bini.name}.yaml"
+end

data/lib/bini/filemagic.rb

@@ -0,0 +1,15 @@
+module Bini
+  module FileMagic
+    extend self
+
+    def mime_type(file)
+      return `file -bk --mime-type "#{file}"`.chomp! if File.exist? file
+      return nil
+    end
+
+    private
+    def filemagic_version
+      `file -v`.split(/^file-(.*)\nmagic file from (.*)\n/)[1]
+    end
+  end
+end

data/lib/bini/mixins.rb

@@ -0,0 +1,5 @@
+class Array
+	def rand
+		self[Random.rand(self.count)]
+	end
+end

data/lib/bini/optparser.rb

@@ -0,0 +1,53 @@
+require 'optparse'
+
+module Bini
+  class OptionParser < ::OptionParser
+    def initialize
+      super
+      @options = {}
+
+      on("-V", "--version", "Print version") { |version| @options[:version] = true}
+    end
+
+    def parse!
+      super
+
+      if @options[:version]
+        if Bini.version
+          puts Bini.version
+        else
+          puts "No version supplied."
+        end
+        exit 0
+      end
+
+      mash Bini.config if Bini.config
+    end
+
+    # These are the hash like bits.
+
+    def clear
+      @options.clear
+    end
+
+    def [](k = nil)
+      return @options[k] if k
+      return @options if @options.any?
+      {}
+    end
+
+    def []=(k,v)
+      @options[k] = v
+    end
+
+    # merge takes in a set of values and overwrites the previous values.
+    # mash does this in reverse.
+    def mash(h)
+      h.merge! @options
+      @options.clear
+      h.each {|k,v| self[k] = v}
+    end
+  end
+  Options = OptionParser.new
+end
+

data/lib/bini/sash.rb

@@ -0,0 +1,98 @@
+require 'fileutils'
+require 'yaml'
+
+module Bini
+  # This is a savable hash, it can be configured and used to store whatever the# contents of the hash are for loading later.  Will serialize in yaml to keep all
+  # the dependencies in ruby stdlib.
+  class Sash < Hash
+
+    attr_accessor :file
+    attr_accessor :backup
+    attr_accessor :mode
+    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}
+      load if @auto_load
+    end
+
+    # The base directory of the save file.
+    def basedir
+      return nil if !file
+      File.dirname File.absolute_path @file
+    end
+
+    # The save file plus an extension.
+    def backup_file
+      "#{@file}.bak"
+    end
+
+    # Save the hash to the file, check for backup and set_mode.
+    def save
+      if any?
+        FileUtils.mkdir_p basedir if !Dir.exist? basedir
+        backup if @backup
+
+        # I do this the long way because I want an immediate sync.
+        f = open(@file, 'w')
+        f.write YAML::dump self
+        f.sync
+        f.close
+
+        set_mode if @mode
+      end
+      true
+    end
+
+    def []=(key,value)
+      store key, value
+      save! if @auto_save == true
+    end
+    # Save the hash to a file, overwriting if necessary.
+    def save!
+      delete_file
+      save
+    end
+
+    # Load the save file into self.
+    def load
+      self.clear
+      if @file && File.exist?(@file) && File.stat(@file).size > 0
+        h = YAML::load open(@file, 'r').read
+        h.each { |k,v| self[k.to_sym] = v}
+        return true
+      end
+      false
+    end
+
+    # Generate a backup file real quick.
+    def backup
+      FileUtils.cp @file, backup_file if File.file? @file
+    end
+
+    # Set the mode of both the save file and backup file.
+    def set_mode
+      # Why are we trying to set_mode when we don't even have a file?
+      return false if !@file
+      File.chmod @mode, @file if File.exist? @file
+
+      # the backup file may not exist for whatever reason, lets not shit if it doesn't.
+      return true if !backup_file
+      File.chmod @mode, backup_file if File.exist? backup_file
+      true
+    end
+
+    private
+
+    # Delete the save file.
+    def delete_file
+      return false if !@file
+      FileUtils.rm @file if File.file? @file
+      return true
+    end
+  end
+end

data/lib/bini/version.rb

@@ -0,0 +1,3 @@
+module Bini
+  VERSION = "0.5.2"
+end

data/spec/bini_spec.rb

@@ -0,0 +1,92 @@
+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
+

data/spec/config_spec.rb

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

data/spec/filemagic_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe "FileMagic" do
+	it "it will return a ruby mime type when targeting a ruby file." do
+		Bini::FileMagic.mime_type("./Rakefile").should eq "text/x-ruby"
+	end
+end

data/spec/mixins_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'bini/mixins'
+
+describe "Array#random" do
+	it "will return a random entry from the array." do
+		a = [1, 2, 3]
+		a.include?(a.rand).should be_true
+	end
+end

data/spec/optparser_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe "optparser" do
+	before (:each) do
+		Options.clear
+		@key = random_hex 4
+		@value = random_hex 4
+	end
+
+	it "behaves like a OptionParser." do
+		Options.kind_of? OptionParser
+	end
+
+	describe "[Hash]" do
+		it "can clear" do
+			Options[:foo] = :bar
+			Options.clear
+			Options[].any?.should be_false
+		end
+
+		it "can set via []=" do
+			Options[@key] = @value
+			Options[@key].should eq @value
+		end
+
+		it "gets all keys with []" do
+			Options[@key] = @value
+			Options[].include?(@key).should be_true
+		end
+
+		it "gets a value with [:key]" do
+			Options[@key] = @value
+			Options[@key].should eq @value
+		end
+
+		it "can mash values (opposite of merge)." do
+			Options[:mash] = 'mush'
+			h = {mash:'notmush'}
+			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
+			Options.parse!
+			Options[@key] = @value
+		end
+	end
+end

data/spec/sash_spec.rb

@@ -0,0 +1,78 @@
+require 'bini'
+
+include Bini
+
+describe "Sash" do
+	def random_file
+		"tmp/sash-#{(0...4).map{rand(16).to_s(16)}.join}.yaml"
+	end
+
+	before (:all) do
+		FileUtils.mkdir_p 'tmp'
+	end
+
+	before (:each) do
+		@filename = random_file
+		@s = Sash.new file:@filename
+		@s[:before_each] = true
+	end
+
+	after (:all) do
+		Dir.glob("tmp/sash-*.yaml*").each { |f| FileUtils.rm f}
+	end
+
+	it "can select the filename" do
+		@s.file.should be @filename
+	end
+
+	it "can save" do
+		@s[:foo] = :bar
+		@s.save
+		@s2 = Sash.new file:@filename
+		@s2.load
+		@s2[:foo].should eq :bar
+	end
+	it "can set the mode" do
+		@s.mode = 0600
+		@s.set_mode
+		@s.save
+		# I have no idea why you put in 0600, 0600 becomes 384, and out comes 33152.
+		# when I figure out where the conversion is going wrong, I'll update this.
+		File.stat(@s.file).mode.should eq 33152
+	end
+
+	it "can auto save" do
+		@s = Sash.new file:@filename, auto_save:true
+		@s[:auto_save] = true
+		@s2 = Sash.new file:@filename
+		@s2.load
+		@s2[:auto_save].should be true
+	end
+
+	it "can auto load" do
+		@s[:auto_load] = true
+		@s.save
+		@s2 = Sash.new file:@filename, auto_load:true
+		@s2[:auto_load].should be true
+	end
+
+	# We save twice because in order to produce a backup file, we need an original.
+	it "can make a backup file" do
+		@s.backup = true
+		@s[:backup] = "something"
+		@s.save
+		@s.save
+		File.exist?(@s.backup_file).should be_true
+	end
+
+	it "will behave like a normal Hash" do
+		@s.kind_of?(Hash).should be_true
+	end
+
+	it "will clear before load, destroying previous contents" do
+		@s[:clear] = 'clear'
+		@s.load
+		@s[:clear].should be_nil
+	end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+require 'bini'
+require 'bini/optparser'
+require 'bini/config'
+
+include Bini
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end
+
+def random_hex(size)
+	(0...size).map{rand(16).to_s(16)}.join
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: bini
+version: !ruby/object:Gem::Version
+  version: 0.5.2
+  prerelease: 
+platform: ruby
+authors:
+- Ernie Brodeur
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sys-proctable
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Bini needs no description.
+email:
+- ebrodeur@ujami.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bini.gemspec
+- lib/bini.rb
+- lib/bini/config.rb
+- lib/bini/filemagic.rb
+- lib/bini/mixins.rb
+- lib/bini/optparser.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/spec_helper.rb
+homepage: https://github.com/erniebrodeur/bini
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -247432938325807426
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -247432938325807426
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: Bini is a gem that helps me build CLI tools.  It's not thor, trollop, or
+  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/spec_helper.rb