code_lister 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 69fbd03709c968f2a211b04e2d898084771ba634
+  data.tar.gz: 271e923a1e2015a46cb12ecd3dc8e7d13aaaade0
+SHA512:
+  metadata.gz: c6c9d6e184576b967e474c95726ca35fa41939a6cf1f19d263a97abb051b4c15407cf9b95150649b7cdf6862c3811a1a6f459346057b5fa9d69e71a3602495ee
+  data.tar.gz: cef3c70b228a91969f011654af1566f63bca5f9a0e4cc9628d436275cb06a3a5f34a5352ca0ea840a3fd9916d3b3c51b1bd3fa87ec6b6d97a8b8165342a357e8

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format progress
+#--format Fuubar

data/.ruby-version

@@ -0,0 +1 @@
+2.1.1

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+guard :rspec do
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Burin Choomnuan
+
+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,79 @@
+## code_lister
+
+This is the simple gem to search/filter the files based on simple criteria.
+It provides the functionality similar to `find` command in Linux/Unix system.
+
+Initially it was part of my internal project. I extracted this out as a gem so
+that I can re-use it in other project. I hope you will find it useful.
+
+### Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'code_lister'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install code_lister
+
+### Usage
+
+#### Using as CLI interface
+
+List all pdf and epub files in the `/opts/downloads/` directory recursively
+
+```sh
+$code_lister find --base-dir /opt/downloads/ --exts pdf epub --recursive
+```
+#### Using as ruby library
+
+```ruby
+require 'code_lister'
+include CodeLister
+# To search for everything that ends in '*.java' and '*.rb" recursively
+list1 = CodeLister.files(base_dir: "spec/fixtures", extensions: %w(rb java), recursive: true)
+puts list1
+```
+
+### Development/Testing
+
+```sh
+git clone git@github.com/agilecreativity/code_lister.git
+bundle
+rake -T
+
+# Play around with it using Pry
+rake pry
+
+# Or play around with it using IRB
+rake irb
+```
+
+From inside `Pry` or `IRB`
+
+```ruby
+#include CodeLister
+# To search for everything that ends in '*.java' and '*.rb" recursively
+list1 = CodeLister.files(base_dir: "spec/fixtures", extensions: %w(rb java), recursive: true)
+puts list1
+
+# To filter out the result list
+list2 = CodeLister.filter(list1, inc_words: %w(final complete), exc_words: %w(demo test))
+```
+### Changelogs
+
+#### 0.0.2
+
+- initial release
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/code_lister/fork )
+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,25 @@
+require "bundler/gem_tasks"
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+
+task :irb do
+  require 'irb'
+  require 'awesome_print'
+  require 'irb/completion'
+  require 'code_lister'
+  include CodeLister
+  ARGV.clear
+  IRB.start
+end
+
+task :pry do
+  require 'pry'
+  require 'awesome_print'
+  require 'code_lister'
+  include CodeLister
+  ARGV.clear
+  Pry.start
+end

data/bin/code_lister

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../lib/code_lister'
+include CodeLister
+CodeLister::CLI.start(ARGV)

data/code_lister.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'code_lister/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "code_lister"
+  spec.version       = CodeLister::VERSION
+  spec.authors       = ["Burin Choomnuan"]
+  spec.email         = ["agilecreativity@gmail.com"]
+  spec.summary       = %q{Search, filter files easily using the power of ruby}
+  spec.description   = %q{Use ruby library to search/filter files}
+  spec.homepage      = "https://github.com/agilecreativity/code_lister"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.add_runtime_dependency "thor"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake", "~> 10.1"
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "guard-rspec", "~> 4.2"
+  spec.add_development_dependency "awesome_print", "~> 1.2"
+  spec.add_development_dependency "pry", "~> 0.9"
+  spec.add_development_dependency "fuubar", "~> 1.3"
+end

data/lib/code_lister/cli.rb

@@ -0,0 +1,76 @@
+require 'thor'
+require_relative 'core_ext/hash'
+module CodeLister
+  class CLI < Thor
+
+    desc "find", "List files by extension, patterns, and other criteria"
+
+    method_option :base_dir,
+                  aliases: "-b",
+                  desc: "Base directory",
+                  default: Dir.pwd
+
+    method_option :exts,
+                  aliases: "-e",
+                  desc: "List of extensions to search for",
+                  type: :array,
+                  default: %w(rb)
+
+    method_option :inc_words,
+                  aliases: "-i",
+                  desc: "List of words to be included in the result if any",
+                  type: :array,
+                  default: []
+
+    method_option :exc_words,
+                  aliases: "-x",
+                  desc: "List of words to be excluded from the result if any",
+                  type: :array,
+                  default: []
+
+    method_option :recursive,
+                  aliases: "-r",
+                  desc: "Search for files recursively",
+                  type: :boolean,
+                  default: false
+
+    method_option :version,
+                  aliases: "-v",
+                  desc: "Display version information",
+                  type: :boolean,
+                  default: false
+    def find
+
+      if options[:version]
+        puts "You are using CodeLister Version #{CodeLister::VERSION}"
+        exit
+      end
+
+      CodeLister::Main.run(options.symbolize_keys)
+    end
+
+    # Note: we don't use help so that we can run :r !./bin/code_lister help find
+    # to see the update help if we have to without commenting out
+    desc "usage", "Display help screen"
+    def usage
+      puts <<-EOS
+Usage:
+  code_lister find
+
+Options:
+  -b, [--base-dir=BASE_DIR]            # Base directory
+                                       # Default: /Users/agilecreativity/Dropbox/spikes/code_explorer
+  -e, [--exts=one two three]           # List of extensions to search for
+                                       # Default: ["rb"]
+  -i, [--inc-words=one two three]      # List of words to be included in the result if any
+  -x, [--exc-words=one two three]      # List of words to be excluded from the result if any
+  -r, [--recursive], [--no-recursive]  # Search for files recursively
+  -v, [--version], [--no-version]      # Display version information
+
+List files based on select multiple criteria
+      EOS
+    end
+
+    default_task :usage
+  end
+end

data/lib/code_lister/code_lister.rb

@@ -0,0 +1,54 @@
+module CodeLister
+
+  CustomError = Class.new(StandardError)
+
+  class << self
+
+    # List files base on some extension
+    def files(args = {})
+      opts = {
+        base_dir: Dir.pwd,
+        recursive: false,
+        exts: [],
+      }.merge(args)
+
+      base_dir = opts[:base_dir]
+      raise CustomError, "The directory #{base_dir} is not valid or or not readable!" unless File.exists?(base_dir)
+      wildcard = opts[:recursive] ? '**' : ''
+      exts = opts[:exts]
+      patterns = File.join(base_dir, wildcard, "*.{#{exts.join(",")}}")
+
+      Dir.glob(patterns).sort
+    end
+
+    # Filter out the list based on given list of words
+    def filter(file_list, args = {})
+      opts = {
+        inc_words: [],
+        exc_words: []
+      }.merge(args)
+
+      inc_words = opts[:inc_words]
+      exc_words = opts[:exc_words]
+
+      take_any!(file_list, inc_words)
+      drop_any!(file_list, exc_words)
+
+      file_list
+    end
+
+    private
+
+    def take_any!(file_list, words)
+      # need to take only the filename
+      file_list.select! { |f| words.any? { |w| /#{w}/ =~ File.basename(f) } } unless words.empty?
+      file_list
+    end
+
+    def drop_any!(file_list, words)
+      file_list.delete_if { |f| words.any? { |w| /#{w}/ =~ File.basename(f) } } unless words.empty?
+      file_list
+    end
+
+  end
+end

data/lib/code_lister/core_ext/hash.rb

@@ -0,0 +1,35 @@
+class Hash
+
+  # File activesupport/lib/active_support/core_ext/hash/keys.rb
+  #
+  # hash = { name: 'Rob', age: '28' }
+  # hash.transform_keys{ |key| key.to_s.upcase }
+  # => { "NAME" => "Rob", "AGE" => "28" }
+  def transform_keys
+    result = {}
+    each_key do |key|
+      result[yield(key)] = self[key]
+    end
+    result
+  end
+
+  def transform_keys!(&block)
+    keys.each do |key|
+      value = delete(key)
+      self[yield(key)] = value.is_a?(Hash) ? value.transform_keys!(&block) : value
+    end
+    self
+  end
+
+  # hash = { 'name' => 'Rob', 'age' => '28' }
+  # hash.symbolize_keys
+  # => { name: "Rob", age: "28" }
+  def symbolize_keys
+    transform_keys{ |key| key.to_sym rescue key }
+  end
+
+  # File activesupport/lib/active_support/core_ext/hash/keys.rb, line 135
+  def symbolize_keys!
+    transform_keys!{ |key| key.to_sym rescue key }
+  end
+end

data/lib/code_lister/logger.rb

@@ -0,0 +1,10 @@
+require 'logger'
+module CodeLister
+  class << self
+    attr_writer :logger
+    # @return [Logger] the Logger for the project
+    def logger
+      @logger ||= Logger.new STDOUT
+    end
+  end
+end

data/lib/code_lister/main.rb

@@ -0,0 +1,35 @@
+module CodeLister
+  class Main
+    class << self
+
+      def run(options = {})
+        args = default_options.merge(options)
+
+        files = CodeLister.files(args)
+
+        ## Now filter out the list any?
+        inc_words = args.fetch(:inc_words, [])
+        exc_words = args.fetch(:exc_words, [])
+
+        files = CodeLister.filter(files, inc_words: inc_words,
+                                         exc_words: exc_words)
+        # TODO: remove when done!
+        puts files
+
+        files
+      end
+
+      private
+
+      def default_options
+        options = {
+          base_dir: Dir.pwd,
+          recursive: false,
+          inc_words: [],
+          exc_words: [],
+          exts: []
+        }
+      end
+    end
+  end
+end

data/lib/code_lister/version.rb

@@ -0,0 +1,3 @@
+module CodeLister
+  VERSION = "0.0.2"
+end

data/lib/code_lister.rb

@@ -0,0 +1,5 @@
+require_relative 'code_lister/version'
+require_relative 'code_lister/logger'
+require_relative 'code_lister/code_lister'
+require_relative 'code_lister/cli'
+require_relative 'code_lister/main'

data/spec/code_lister/code_lister_spec.rb

@@ -0,0 +1,47 @@
+require_relative '../spec_helper'
+describe CodeLister do
+
+  let(:file_list) {
+    CodeLister.files(base_dir: 'spec/fixtures', exts: %w(xxx.rb), recursive: true)
+  }
+
+  context "#files" do
+    it 'works with invalid input' do
+      expect{ CodeLister.files('bad-args')}.to raise_error
+    end
+
+    it 'works with valid input' do
+      expect(CodeLister.files(base_dir: 'spec/fixtures', exts: %w(xxx.rb))).to eq ['spec/fixtures/demo1.xxx.rb',
+                                                                                   'spec/fixtures/demo2.xxx.rb']
+    end
+
+    it 'returns empty result if no match found' do
+      expect(CodeLister.files(base_dir: 'spec/fixtures', exts: %w(invalid-extension))).to eq []
+    end
+  end
+
+  context "#filter" do
+    it "works with empty filter inputs" do
+      expect(CodeLister.filter(file_list, inc_words: [], exc_words: [])).to eq file_list
+    end
+
+    it "works with unique match" do
+      expect(CodeLister.filter(file_list, inc_words: %w(demo1))).to eq ["spec/fixtures/demo1.xxx.rb"]
+    end
+
+    it "works with multiples matches" do
+      expect(CodeLister.filter(file_list, inc_words: %w(demo))).to eq ["spec/fixtures/demo1.xxx.rb",
+                                                                       "spec/fixtures/demo2.xxx.rb"]
+
+      expect(CodeLister.filter(file_list, inc_words: %w(xxx))).to eq ["spec/fixtures/demo1.xxx.rb",
+                                                                      "spec/fixtures/demo2.xxx.rb"]
+    end
+
+    it "filters out the words that we don't want" do
+      expect(CodeLister.filter(file_list, exc_words: %w(demo1))).to eq ["spec/fixtures/demo2.xxx.rb"]
+
+      expect(CodeLister.filter(file_list, exc_words: %w(xxx))).to eq []
+    end
+  end
+
+end

data/spec/fixtures/demo1.xxx.rb

@@ -0,0 +1 @@
+# file: spec/fixtures/demo1.xxx.rb

data/spec/fixtures/demo2.xxx.rb

@@ -0,0 +1 @@
+# file: spec/fixtures/demo2.xxx.rb

data/spec/fixtures/java/demo3.xxx.java

@@ -0,0 +1 @@
+// file: test/fixtures/java/demo3.java

data/spec/fixtures/java/demo4.xxx.java

@@ -0,0 +1 @@
+// file: test/fixtures/java/demo4.java

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+# 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
+
+require_relative "../lib/code_lister"
+include CodeLister

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: code_lister
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Burin Choomnuan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  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.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  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'
+description: Use ruby library to search/filter files
+email:
+- agilecreativity@gmail.com
+executables:
+- code_lister
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/code_lister
+- code_lister.gemspec
+- lib/code_lister.rb
+- lib/code_lister/cli.rb
+- lib/code_lister/code_lister.rb
+- lib/code_lister/core_ext/hash.rb
+- lib/code_lister/logger.rb
+- lib/code_lister/main.rb
+- lib/code_lister/version.rb
+- spec/code_lister/code_lister_spec.rb
+- spec/fixtures/demo1.xxx.rb
+- spec/fixtures/demo2.xxx.rb
+- spec/fixtures/java/demo3.xxx.java
+- spec/fixtures/java/demo4.xxx.java
+- spec/spec_helper.rb
+homepage: https://github.com/agilecreativity/code_lister
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Search, filter files easily using the power of ruby
+test_files:
+- spec/code_lister/code_lister_spec.rb
+- spec/fixtures/demo1.xxx.rb
+- spec/fixtures/demo2.xxx.rb
+- spec/fixtures/java/demo3.xxx.java
+- spec/fixtures/java/demo4.xxx.java
+- spec/spec_helper.rb
+has_rdoc: