IniSearch 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3974ecc9f4b8a97ba245e39db1b192355f648c2b
+  data.tar.gz: 054f3d5abac34a4cb5285c3b729f646da2633db0
+SHA512:
+  metadata.gz: 1a3f7472c5d3ffc3412e98e538e487b5c447cc2176173691b4da0fd83e91fc2b5e983be73bb94f6af38854441843cd0ba4c48fdfefb09da62e0d3c5b99b2bcbd
+  data.tar.gz: 01bb2532426ac2128fccceb948f47aaa920ec56213cfa1a7d1d0bd5baf53a518cf1e52c529024d57d5003ceabf8bb927a90cc8b911421879c5c9b9152159a19b

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+foo.*

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+
+before_install: "gem install bones"
+install:        "rake gem:install_dependencies"
+
+script: "rake"
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem "rake"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,19 @@
+PATH
+  remote: .
+  specs:
+    IniSearch (0.0.1)
+      inifile
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    inifile (3.0.0)
+    rake (10.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  IniSearch!
+  bundler (~> 1.0)
+  rake

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 shadowbq
+
+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,78 @@
+ini_search
+==========
+
+This is a native Ruby package for searching INI files to find enabled keys.
+
+Description
+-----------
+
+Usage of `ini-search` binary.
+
+	Search ini configs
+	Usage: ~/ini-search [options]
+	    -s [section regex string],       default: .*
+	        --section                    Section name as a regular expression to match
+	    -k, --key [searchkey]            default: key
+	                                     Stanza key
+	    -x, --check-for-existance        default: false
+	                                     Report existance of key in Stanza
+	    -f, --file [configfilename]      Individual ini file
+	    -v, --verbose                    Verbose output
+	    -z, --max-verbose                Max Verbose output
+	    -h, --help                       Display this screen
+
+### Example Use
+
+	$ ini-search -f ~/.rvm/gems/ruby-2.1.2/gems/IniSearch-0.0.1/test/data/good.ini -k one
+	section_one:one
+
+
+### Example File Format Matches
+
+A typical INI file might look like this:
+
+    [section1]
+    ; some comment on section1
+    var1 = false
+    var2 = true
+    varA = Foobar
+    var3 = multiline values \
+    are also possible
+
+    [section2]
+    # another comment
+    var10 = baz
+    var20 = 1	    
+
+We would be looking for section1:var2, section2:var20 as *Enabled* settings
+
+
+### Identifying Enabled Variables
+
+* 1  -->  Enabled
+* ""  -->  Disabled
+* "42"  -->  Set
+* "1"  -->  Enabled
+* "3.14159"  -->  Set
+* "true"  -->  Enabled
+* true  -->  Enabled
+* "false"  -->  Disabled
+* "normal string"  -->  Set
+
+Install
+-------
+
+    gem install IniSearch
+
+Testing
+-------
+
+To run the tests:
+
+    $ rake
+
+License
+-------
+
+MIT License
+Copyright (c) 2006 - 2014    

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rake/testtask'
+require "bundler/gem_tasks"
+
+task :default => [:test]
+
+Rake::TestTask.new do |test|
+  test.libs << "test" 
+  test.test_files = Dir[ "test/test_*.rb" ]
+  test.verbose = true
+end

data/bin/ini-search

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+require 'rubygems' unless defined?(Gem)
+begin
+  require 'bundler'
+  Bundler.setup(:default)
+rescue ::Exception => e
+end
+
+require 'ini_search'
+
+# Executable with absolute path to lib for hacking and development
+require File.join(File.dirname(__FILE__), '..', 'lib', 'ini_search', 'cli')
+
+IniSearch::CLI.invoke

data/ini_search.gemspec

@@ -0,0 +1,38 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require File.expand_path('../lib/ini_search/version', __FILE__)
+name = "IniSearch"
+
+Gem::Specification.new do |s|
+  s.name               = name
+  s.version            = IniSearch::VERSION
+ 
+  s.authors = ["shadowbq"]
+  s.date = %q{2014-08-01}
+  s.description = %q{A simple ini search gem}
+  s.email = %q{shadowbq@gmail.com}
+
+  s.files = `git ls-files`.split("\n")
+  s.homepage    = "http://github.com/shadowbq/#{name}"
+
+
+  s.summary = s.description
+  s.license     = 'MIT'
+  s.platform    = Gem::Platform::RUBY
+  s.executables = ["ini-search"]
+
+  s.required_rubygems_version = ">= 1.8.1"
+
+  s.add_development_dependency 'bundler', '~> 1.0'
+
+  s.add_runtime_dependency 'inifile'
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/ini_search/cli.rb

@@ -0,0 +1,78 @@
+module IniSearch
+  class CLI
+
+    def self.invoke
+      self.new
+    end
+
+    def initialize  
+      @options = {}
+      @options[:verbose] = 0
+      @options[:key] = 'key'
+      @options[:sect_regexp] = Regexp.new('.*')
+      @options[:find_existance] = false
+
+      optparse = OptionParser.new do |opts|
+        opts.banner = "Search ini configs"
+        opts.separator "Usage: #$0 [options]"
+
+        opts.on( '-s', '--section [section regex string]', "default: #{@options[:sect_regexp].source}", 'Section name as a regular expression to match') do |section|
+          @options[:sect_regexp] =  Regexp.new(section)
+        end
+
+        opts.on( '-k', '--key [searchkey]', "default: #{@options[:key]}", 'Stanza key') do |key|
+          @options[:key] = key
+        end
+
+        opts.on( '-x', '--check-for-existance ', "default: #{@options[:find_existance]}", 'Report existance of key in Stanza') do
+          @options[:find_existance] = true
+        end
+
+        opts.on( '-f', '--file [configfilename]', 'Individual ini file') do |conf|
+          @options[:file] = conf
+        end
+
+        opts.on('-v', '--verbose', 'Verbose output') do
+          @options[:verbose] = 1
+        end
+
+        opts.on('-z', '--max-verbose', 'Max Verbose output') do
+          @options[:verbose] = 2
+        end
+
+        opts.on_tail( '-h', '--help', 'Display this screen' ) do
+          puts opts
+          exit
+        end
+
+      end  
+    
+      #Verify the options
+      begin
+        raise unless ARGV.size > 0
+        optparse.parse!
+        exclusive_options = [:verbose, :scandir]
+
+        if (exclusive_options.collect{|item| item if @options.include? item}.compact).length > 1 
+          puts "Error: Mutually Exclusive options were selected"    
+          puts optparse
+          exit
+        end
+       
+      #If options fail display help
+      rescue
+        puts optparse
+        exit
+      end
+
+      begin
+        Searcher.new(obj_inifile: IniFile.new(:filename => @options[:file]), key: @options[:key],  sect_regexp: @options[:sect_regexp], find_existance: @options[:find_existance], verbosity: @options[:verbose])
+      rescue
+        $stderr.puts "Could not read #{@options[:file]}"
+        exit 1
+      end
+
+    end
+  
+  end
+end    

data/lib/ini_search/helper.rb

@@ -0,0 +1,7 @@
+module IniSearch
+  module Helper
+    def verbose(msg, level=0)
+      puts msg if level > 0 
+    end 
+  end
+end

data/lib/ini_search/searcher.rb

@@ -0,0 +1,59 @@
+module IniSearch
+  class Searcher
+    include Helper
+
+    def initialize(arg={})
+      @inifile = arg[:obj_inifile] || (raise MissingIniFile)
+      @verbosity = arg[:verbosity] || 0
+      @key = arg[:key] || (raise MissingSearchKey)
+      @find_existance = arg[:find_existance] || false
+      @section_regex = arg[:sect_regexp] || Regexp.new('.*')
+      do_search
+    end
+
+    private
+
+		#obj_inifile, key, find_existance
+    def do_search
+      @inifile.each_section do |section| 
+        if @inifile[section].has_key?(@key) && section.match(@section_regex)
+          verbose("Found '#{section}:#{@key}' Exists: ", @verbosity) if @find_existance
+          puts "#{section}" if @find_existance
+          if key_enabled?(section) && !(key_falsy?(section))
+          	verbose("Found '#{section}:#{@key}' Enabled: #{@inifile[section][@key]} ", @verbosity)
+            puts "#{section}:#{@key}" 
+          elsif key_falsy?(section)
+            verbose("Found '#{section}:#{@key}' Disabled: #{@inifile[section][@key]} ", @verbosity)
+          else 
+            verbose("Found '#{section}:#{@key}' Set: #{@inifile[section][@key]} ", @verbosity)
+          end
+        end
+      end #enum
+    end #def
+
+    def key_enabled?(section)
+    	begin 
+        if @inifile[section][@key].to_s == "1" || @inifile[section][@key].to_s.downcase == "true" || @inifile[section][@key] == true
+          return true
+        else
+          return false
+        end
+      rescue 
+        raise FailureIniDataSet
+      end  
+    end
+
+    def key_falsy?(section)
+      begin
+        if @inifile[section][@key].to_s == "0" ||  @inifile[section][@key] == "" || @inifile[section][@key].to_s.downcase == "false"
+          return true
+        else        
+          return false
+        end
+      rescue 
+        raise FailureIniDataSet
+      end   
+    end
+
+	end
+end

data/lib/ini_search/version.rb

@@ -0,0 +1,3 @@
+module IniSearch
+    VERSION = '0.0.1'
+end

data/lib/ini_search.rb

@@ -0,0 +1,22 @@
+require 'inifile'
+require 'optparse'
+require 'rubygems' unless defined?(Gem)
+
+module IniSearch
+  class MissingIniFile < StandardError; end
+  class MissingSearchKey < StandardError; end
+  class FailureIniDataSet < StandardError; end
+
+  $:.unshift(File.dirname(__FILE__))
+  %w( helper cli searcher ).each do |lib|
+    begin
+      require "ini_search/#{lib}"
+    rescue LoadError
+       require File.expand_path(File.join(File.dirname(__FILE__), 'ini_search', lib))
+    end
+  end
+
+end
+
+
+

data/test/data/good.ini

@@ -0,0 +1,18 @@
+[section_one]
+one = 1
+two = 2
+
+[section_two]
+three =         -3
+multi = multiline \
+support
+
+; comments should be ignored
+[section three]
+four   =true
+five=false   # comments can go here
+six =6.0     ; and here, too
+
+[section_four]
+   [section_five]
+ seven and eight= 7 & 8

data/test/test_ini_search.rb

@@ -0,0 +1,65 @@
+# encoding: UTF-8
+
+libpath = File.expand_path '../../lib', __FILE__
+require File.join(libpath, 'ini_search')
+require 'fileutils'
+require 'test/unit'
+
+
+class TestIniSearch < Test::Unit::TestCase
+
+  def setup
+    @ini_file = IniFile.new(:filename => 'test/data/good.ini')
+    FileUtils.cp    "test/data/good.ini", "test/data/tmp.ini"
+  end
+
+  def teardown
+    FileUtils.rm_rf "test/data/tmp.ini"
+  end
+
+  def test_class_load
+    ini_file = IniFile.load 'test/data/good.ini'
+    assert_instance_of IniFile, ini_file
+  end
+
+  def test_has_section_eh
+    assert_equal true,  @ini_file.has_section?('section_one')
+    assert_equal false, @ini_file.has_section?('section_ten')
+  end
+
+  def test_read
+    @ini_file.read
+    assert_equal 1, @ini_file['section_one']['one']
+    assert_equal 2, @ini_file['section_one']['two']
+  end
+
+  def test_match_section_regex_1
+    out, err = capture_io do 
+      IniSearch::Searcher.new(obj_inifile: @ini_file, key: 'one',  find_existance: true)
+    end
+    assert_match "section_one\nsection_one:one", out 
+  end
+  
+
+  def test_match_section_regex_2
+    out, err = capture_io do 
+      IniSearch::Searcher.new(obj_inifile: @ini_file, key: 'four',  sect_regexp: Regexp.new('secti.*'))
+    end
+    assert_match "section three:four", out   
+  end
+
+  def test_match_section_regex_3
+    out, err = capture_io do 
+      IniSearch::Searcher.new(obj_inifile: @ini_file, key: 'three',  sect_regexp: Regexp.new('section_.*'))
+    end
+    assert_match "", out   
+  end
+
+    def test_match_section_regex_4
+    out, err = capture_io do 
+      IniSearch::Searcher.new(obj_inifile: @ini_file, key: 'five',  sect_regexp: Regexp.new('section_.*'))
+    end
+    assert_match "", out   
+  end
+
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: IniSearch
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- shadowbq
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: inifile
+  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'
+description: A simple ini search gem
+email: shadowbq@gmail.com
+executables:
+- ini-search
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/ini-search
+- ini_search.gemspec
+- lib/ini_search.rb
+- lib/ini_search/cli.rb
+- lib/ini_search/helper.rb
+- lib/ini_search/searcher.rb
+- lib/ini_search/version.rb
+- test/data/good.ini
+- test/test_ini_search.rb
+homepage: http://github.com/shadowbq/IniSearch
+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: 1.8.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 3
+summary: A simple ini search gem
+test_files: []