my_utilities 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 44d1fd2cb533d01414e41413e15b0d4cd29ff7d1
+  data.tar.gz: f243196f1fabbdba3114d2790943f4801eb3d859
+SHA512:
+  metadata.gz: f02837bbb7c37bbb7ee68f0b3fb6cbfcbe6889d60dab132830de7af7cf9d2e9f543ab34d41e9a83a7331114b3db42e74beebb4dc90075acd5caa60cd41a61022
+  data.tar.gz: 4d1d066c36d9c455a976c041f187fdf8982efc55f9b080405c42bcb84446d60d6a83ef2bbcbff84dee9b9e90ec8a8088593e2e54c1a2ace12450ca3aba0edd9c

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,2 @@
+rvm:
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in my_utilities.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Sameer Siruguri
+
+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,29 @@
+# MyUtilities
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'my_utilities'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install my_utilities
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/lib/my_utilities.rb

@@ -0,0 +1,135 @@
+require "my_utilities/version"
+
+module MyUtilities
+  # MyUtilities class variables
+  @help_string=""
+  @used_single_options = []
+
+  class << self
+    attr_accessor :help_string
+  end
+
+  def self.print_help_and_exit
+    puts <<EOS
+#{__FILE__} [options]
+#{@help_string}
+EOS
+
+    exit -1
+  end
+
+  def self.error_exit(msg)
+    puts "ERROR: #{msg}"
+    exit -1
+  end
+
+  def self.process_cli(opt_map)
+    return [] if Hash != opt_map.class or opt_map.empty?
+    return_array = []
+
+    opt_array = []
+    key_of = {}
+    opt_map.each do |k, v|
+      # If one of the keys is not a symbol, let's abort.
+      return [] unless k.is_a? Symbol
+
+
+      matches = /^\-(.)(:\-\-(.*)?)/.match v
+      single_opt = long_opt = nil
+
+      # We will generate options regardless of whether the input string is valid.
+      if !matches.nil?
+        single_opt = matches[1]
+        long_opt = matches[3]
+      end
+
+      gen_opt1, gen_opt2 = generate_option_strings
+      single_opt ||= gen_opt1
+      long_opt ||= gen_opt2
+      key_of["--#{long_opt}"]=k
+
+      opt_array << ["--#{long_opt}," "-#{single_opt}", GetoptLong::OPTIONAL_ARGUMENT]
+    }
+
+    opts = GetoptLong.new opt_array
+
+    opts.each do |opt, arg|
+      return_array[key_of[opt]]=arg
+    end
+
+    return_array
+   end
+end
+
+  end
+
+  class Logger
+    DEBUG=4
+    INFO=3
+    WARN=2
+    ERROR=1
+    FATAL=0
+
+    def initialize(level=FATAL)
+      @mesg_level = level.to_i
+    end
+
+    def debug(mesg)
+      self.puts mesg, DEBUG
+    end
+
+    def fatal(mesg)
+      self.puts mesg, FATAL
+    end
+
+    def puts(mesg, level=DEBUG)
+      if @mesg_level >= level
+        super mesg
+      end
+    end
+  end
+
+  module MyDir
+    def self.included base
+      base.extend MyDirMethods
+    end
+    module MyDirMethods
+      def parent_dir_match(rx, dir=".")
+
+        # nil if this isn't a directory we're starting from
+        return nil if !Dir.exists? dir
+        
+        return dir if !(Dir.entries(dir).select { |x| rx.match x and File.file? File.join(dir, x) }.empty?)
+        
+        # Don't recurse if the dir's parent is the dir
+        return parent_dir_match(rx, File.join(dir, "..")) if(File.expand_path(dir) != '/')
+        nil
+      end
+    end
+  end
+
+  private 
+  def self.generate_option_strings
+    a=generate_single_option
+    return [a, "#{a}_long_option"]
+  end
+
+  def self.generate_single_option
+    # This will fail terribly after 62 incorrectly specified options
+    ([a..z]+[A..Z]+[0..9]).each do |opt|
+      unless @used_single_options.include? opt
+        @used_single_options << opt
+        return opt
+      end
+    end
+
+    return 'a'
+  end
+
+end
+
+class Dir
+  include MyUtilities::MyDir
+end
+
+

data/lib/my_utilities/version.rb

@@ -0,0 +1,3 @@
+module MyUtilities
+  VERSION = "1.2.0"
+end

data/my_utilities.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'my_utilities/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "my_utilities"
+  spec.version       = MyUtilities::VERSION
+  spec.authors       = ["Sameer Siruguri"]
+  spec.email         = ["sameers.public@gmail.com"]
+  spec.description   = %q{Some common utilities I've created for my Ruby work}
+  spec.summary       = %q{These functions do a bunch of cool things, like log error messages, find a parent folder with a specific file in it, and so on.} 
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(spec)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'getoptlong'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency "rake"
+end

data/spec/logger_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+require_relative "../lib/my_utilities"
+
+describe MyUtilities do
+  describe "::print_help_and_exit" do
+    before do
+      # Set the help string
+      @help_string = 'this is the help string'
+      MyUtilities.help_string = @help_string
+    end
+    
+    it "prints out the help string" do
+      full_help_string = "#{__FILE__} [options]\n#{@help_string}\n"
+      STDOUT.should_receive(:puts).with(/#{@help_string}/)
+      lambda { MyUtilities::print_help_and_exit }.should raise_error(SystemExit)
+    end
+  end
+
+  describe MyUtilities::Logger do
+    before do
+      @exp_mesg="Fatal, die now!"
+    end
+
+    before do
+      @logger_default=MyUtilities::Logger.new
+      @logger_by_level = MyUtilities::Logger.new(MyUtilities::Logger::WARN)
+    end
+
+    it "only shows fatal message by default" do
+      STDOUT.should_receive(:puts).with(@exp_mesg)
+      @logger_default.puts(@exp_mesg, MyUtilities::Logger::FATAL)
+    end
+
+    context "level is init'ed (to WARN)" do
+      it "won't print debug messages" do
+        STDOUT.should_not_receive(:puts)
+        @logger_by_level.puts(@exp_mesg, MyUtilities::Logger::DEBUG)
+      end
+
+      it "will print WARN messages" do 
+        STDOUT.should_receive(:puts).with(@exp_mesg)
+        @logger_by_level.puts(@exp_mesg, MyUtilities::Logger::WARN)
+      end
+
+      it "will print fatal messages" do
+        STDOUT.should_receive(:puts).with(@exp_mesg)
+        @logger_by_level.puts(@exp_mesg, MyUtilities::Logger::FATAL)
+      end
+    end
+
+    it "only shows debug messages if no level is given and debug level is init'ed" do
+      
+      @logger_debug = MyUtilities::Logger.new(MyUtilities::Logger::DEBUG)
+
+      STDOUT.should_receive(:puts).with(@exp_mesg)
+      @logger_debug.puts(@exp_mesg)
+
+      STDOUT.should_not_receive(:puts)
+      @logger_by_level.puts(@exp_mesg) 
+    end
+  end
+
+  describe MyUtilities::MyDir do 
+    before do
+      Dir.chdir 'spec/tmp/test_parent_if/level1' unless /level1/.match Dir.pwd
+    end
+    it "should work positive" do
+      Dir.parent_dir_match(Regexp.new('findthis')).should eq('./..')
+      Dir.parent_dir_match(Regexp.new('findthis'), '../..').should eq('../..')
+    end
+    it "should not work negative" do
+      Dir.parent_dir_match(Regexp.new('cantfindthis')).should be_nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+# our gem
+require 'my_utilities'
+
+RSpec.configure do |config|
+
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: my_utilities
+version: !ruby/object:Gem::Version
+  version: 1.2.0
+platform: ruby
+authors:
+- Sameer Siruguri
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: getoptlong
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Some common utilities I've created for my Ruby work
+email:
+- sameers.public@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/my_utilities.rb
+- lib/my_utilities/version.rb
+- my_utilities.gemspec
+- spec/logger_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: These functions do a bunch of cool things, like log error messages, find
+  a parent folder with a specific file in it, and so on.
+test_files:
+- spec/logger_spec.rb
+- spec/spec_helper.rb