hash_filter 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0fd98b0f5b9de5021c6eb6d9f7d3b657017a633
-  data.tar.gz: 48aa07a8370204b8ec1303b0bfd0bcf0949cd741
+  metadata.gz: 80b0149bee506b4fa89a5a335dcf391d2ef4b46e
+  data.tar.gz: 9b4f9eb79fa98fd51bb4572b1a0fad591010bad2
 SHA512:
-  metadata.gz: 89aef08668e418b0b05a527679daadf24807fa03fa949af80ed9fcd5e7807419a6d53ca207fbb93dea199d9ea91baa8683fce9a333649dbccfeb4f0814d19267
-  data.tar.gz: 6ce702c885d18b18e8b75419c7c47ea875a245cf743e05d0da9ea11cbe5b17c0de483aae853a70df9e9ba76f2bef8ad4f396048abef5fb5913916044e2fcea5a
+  metadata.gz: a7154e0eb2ff59b51004809604968fed59a431c608982291678fed7013925faf21dd065efb0cc4f3724fd86f92b906eca52a7e888fb73c74b467ad68abea93d8
+  data.tar.gz: dfa89dcd2cbec9a9aefbde9710ecaf513682aa300093f40732a2371d31581674b49dcf58173164edcc2b154da317fa601aafa6e3863c5b5adb3dce92b5043304

data/.travis.yml

@@ -1,11 +1,28 @@
+language: ruby
+sudo: false
+cache: bundler
 rvm:
   - 1.9.3
   - 2.0
   - 2.1
+  - 2.2
   - ruby-head
   - jruby
+  - jruby-head
   - rbx-2
+env:
+  global:
+    - CODECLIMATE_REPO_TOKEN=0a29827fa48b1236e7c27bf9948e3ee3cb05d50630a2896014edd7b7bbf616a2
+    - JRUBY_OPTS='--dev -J-Xmx1024M'
 matrix:
+  fast_finish: true
   allow_failures:
     - rvm: ruby-head
-  fast_finish: true
+    - rvm: jruby-head
+notifications:
+  webhooks:
+    urls:
+      - https://webhooks.gitter.im/e/c696eaa01bc1bae73cb2
+    on_success: change  # options: [always|never|change] default: always
+    on_failure: always  # options: [always|never|change] default: always
+    on_start: false     # default: false

data/CHANGELOG.md

@@ -1,22 +1,27 @@
 # Changelog
 
-## vX.X.X
+## v0.1.1
 
 * Enhancements
+  * Improve docs (@splattael)
+
+## v0.1.0
 
 * Bug fixes
+  * Take over `keep` operations via `inject` (@splattael)
 
-* Deprecations
+## v0.0.1
 
-* Backwards incompatible changes
+* Enhancements
+  * Initial implementation (@splattael)
+  * Implement `keep` operation (@splattael)
 
-## v0.1.0
+## vX.X.X
+
+* Enhancements
 
 * Bug fixes
-  * Take over `keep` operations via `inject`
 
-## v0.0.1
+* Deprecations
 
-* Enhancements
-  * Initial implementation
-  * Implement `keep` operation
+* Backwards incompatible changes

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in hash_filter.gemspec
 gemspec
+
+if ENV['CODECLIMATE_REPO_TOKEN']
+  gem "codeclimate-test-reporter", :group => :test, :require => nil
+end

data/README.md

@@ -1,6 +1,21 @@
+[github]: https://github.com/neopoly/hash_filter
+[doc]: http://rubydoc.info/github/neopoly/hash_filter/master/file/README.md
+[gem]: https://rubygems.org/gems/hash_filter
+[travis]: https://travis-ci.org/neopoly/hash_filter
+[codeclimate]: https://codeclimate.com/github/neopoly/hash_filter
+[inchpages]: https://inch-ci.org/github/neopoly/hash_filter
+
 # HashFilter
 
-[![Build Status](http://img.shields.io/travis/neopoly/hash_filter.svg?branch=master)](https://travis-ci.org/neopoly/hash_filter) [![Gem Version](http://img.shields.io/gem/v/hash_filter.svg)](https://rubygems.org/gems/hash_filter) [![Code Climate](http://img.shields.io/codeclimate/github/neopoly/hash_filter.svg)](https://codeclimate.com/github/neopoly/hash_filter) [![Inline docs](http://inch-ci.org/github/neopoly/hash_filter.svg?branch=master)](http://inch-ci.org/github/neopoly/hash_filter)
+[![Travis](https://img.shields.io/travis/neopoly/hash_filter.svg?branch=master)][travis]
+[![Gem Version](https://img.shields.io/gem/v/hash_filter.svg)][gem]
+[![Code Climate](https://img.shields.io/codeclimate/github/neopoly/hash_filter.svg)][codeclimate]
+[![Test Coverage](https://codeclimate.com/github/neopoly/hash_filter/badges/coverage.svg)][codeclimate]
+[![Inline docs](https://inch-ci.org/github/neopoly/hash_filter.svg?branch=master&style=flat)][inchpages]
+
+[Gem][gem] |
+[Source][github] |
+[Documentation][doc]
 
 A simple hash filter.
 
@@ -21,33 +36,31 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
-
-  remove_images = HashFilter.new do
-    delete /\.jpg$/
-    delete /\.png$/
-    delete /\.gif$/
-  end
-
-  rename_html = HashFilter.new do
-    rename /(.*?)\.htm$/, '\1.html'
-  end
-
-  filter = HashFilter.new do
-    inject remove_images
-    inject rename_html
-  end
-
-  hash = {
-    "image.jpg" => "/path/to/image.jpg",
-    "image.png" => "/path/to/image.png",
-    "page.htm"  => "/path/to/page.html"
-  }
-
-  p filter.apply hash
-  # {
-  #   "page.html" => "/path/to/page.html"
-  # }
-
+remove_images = HashFilter.new do
+  delete /\.jpg$/
+  delete /\.png$/
+  delete /\.gif$/
+end
+
+rename_html = HashFilter.new do
+  rename /(.*?)\.htm$/, '\1.html'
+end
+
+filter = HashFilter.new do
+  inject remove_images
+  inject rename_html
+end
+
+hash = {
+  "image.jpg" => "/path/to/image.jpg",
+  "image.png" => "/path/to/image.png",
+  "page.htm"  => "/path/to/page.html"
+}
+
+p filter.apply hash
+# {
+#   "page.html" => "/path/to/page.html"
+# }
 ```
 
 ## Contributing

data/lib/hash_filter.rb

@@ -1,42 +1,117 @@
 require 'hash_filter/operation'
 
+# Easy hash filtering via simple operations
+#
+# @see README
 class HashFilter
-  attr_reader :operations, :keeps
+  # List of operations to be applied
+  attr_reader :operations
+
+  # List of elements to keep before applying operations
+  attr_reader :keeps
+
   protected :operations, :keeps
 
+  # Initialize a hash filter
+  #
+  # @yield [HashFilter] instance evals self if a block is provided
+  #
+  # @example
+  #   filter = HashFilter.new do
+  #     rename /(.*?)\.htm$/, '\1.html'
+  #     delete /\.(jpg|gif)$/
+  #   end
+  #
+  #   filter.delete /\.png$/
+  #
+  #   filter.apply(some_hash)
   def initialize(&block)
     @keeps      = []
     @operations = []
     instance_eval(&block) if block
   end
 
+  # Rename a key
+  #
+  # @param from [Regexp, String] rename source
+  # @param to [String] rename target
+  #
+  # @example
+  #   HashFilter.new do
+  #     rename /(.*?)\.htm$/, '\1.html'
+  #   end
   def rename(from, to)
     operation Operation::Rename, from, to
   end
 
+  # Delete a key
+  #
+  # @param key [Regexp, String] key to delete
+  #
+  # @example
+  #   remove_images = HashFilter.new do
+  #     delete /\.jpg$/
+  #     delete /\.png$/
+  #     delete /\.gif$/
+  #   end
   def delete(key)
     operation Operation::Delete, key
   end
 
+  # Combine other filters
+  #
+  # @param filter [HashFilter] other filter
   def inject(filter)
     @keeps.concat filter.keeps
     @operations.concat filter.operations
   end
 
+  # Keep given key
+  #
+  # @param key [Regexp, String] key to keep
+  #
+  # @example
+  #   # Delete everything but keep GIFs
+  #   HashFilter.new do
+  #     keep /\.gif$/
+  #     delete /.*/
+  #   end
   def keep(key)
     @keeps << key
   end
 
+  # Apply this filter to hash
+  #
+  # @param hash [Hash] hash (hash-like) to filter
   def apply(hash)
     apply_operations(@operations, hash.dup)
   end
 
+  # Add a custom operation
+  #
+  # @param class_name [Operation] operation class
+  #
+  # @example
+  #   class SwapKeyValue < HashFilter::Operation
+  #     def execute(hash, key)
+  #       value = hash.delete(key)
+  #       hash[value] = key
+  #     end
+  #   end
+  #
+  #   HashFilter.new do
+  #     operation SwapKeyValue
+  #   end
   def operation(class_name, *args)
     @operations << class_name.new(*args)
   end
 
   private
 
+  # Applies all operations to target hash
+  #
+  # @param operations [Array<Operation>] a list of operations
+  # @param hash [Hash] target hash
   def apply_operations(operations, hash)
     hash.keys.each do |key|
       next if keep?(key)
@@ -47,10 +122,16 @@ class HashFilter
     hash
   end
 
+  # Should the key be kept?
+  #
+  # @param key [Regexp, String, Object]
   def keep?(key)
     @keeps.any? { |keep| keep === key }
   end
 
+  # Apply a single operation
+  #
+  # @see Operation#execute
   def apply_operation(operation, hash, key)
     if operation.matches?(key)
       operation.execute(hash, key)

data/lib/hash_filter/operation.rb

@@ -1,13 +1,38 @@
 class HashFilter
+  # An abstract operation on a hash during the filter process
+  #
+  # @example
+  #   class SwapKeyValue < HashFilter::Operation
+  #     def execute(hash, key)
+  #       value = hash.delete(key)
+  #       hash[value] = key
+  #     end
+  #   end
+  #
+  #   HashFilter.new do
+  #     operation SwapKeyValue
+  #   end
   class Operation
+    # A new operation
+    #
+    # @param key [String, Regexp, Object]
     def initialize(key)
       @key = key
     end
 
+    # Execute the defined operation
+    #
+    # @param hash [Hash] target hash
+    # @param key [String] key
+    #
+    # @see matches?
     def execute(hash, key)
       raise NotImplementedError
     end
 
+    # Should this operation be executed?
+    #
+    # @param key [Regexp, String, Object] key
     def matches?(key)
       @key === key
     end

data/lib/hash_filter/operation/delete.rb

@@ -1,5 +1,6 @@
 class HashFilter
   class Operation
+    # Delete a key from hash
     class Delete < self
       def execute(hash, key)
         hash.delete(key)

data/lib/hash_filter/operation/rename.rb

@@ -1,6 +1,7 @@
 class HashFilter
   class Operation
-     class Rename < self
+    # Rename a key in a hash
+    class Rename < self
       def initialize(from, to)
         super(from)
         @to = to

data/lib/hash_filter/version.rb

@@ -1,3 +1,3 @@
 class HashFilter
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/hash_filter_spec.rb

@@ -33,6 +33,38 @@ describe HashFilter do
     end
   end
 
+  describe "abstract" do
+    let(:abstract) do
+      Class.new(HashFilter::Operation) {}
+    end
+    let(:unused) { :unused }
+
+    it "requires execute to be implemented" do
+      assert_raises NotImplementedError do
+        abstract.new(unused).execute(unused, unused)
+      end
+    end
+
+    it "matches a string key" do
+      operation = abstract.new("key")
+
+      assert operation.matches?("key")
+
+      refute operation.matches?("nope")
+      refute operation.matches?("KEY")
+    end
+
+    it "matches a regexp key" do
+      operation = abstract.new(/key/i)
+
+      assert operation.matches?("key")
+      assert operation.matches?("KEY")
+      assert operation.matches?("subkey")
+
+      refute operation.matches?("nope")
+    end
+  end
+
   describe "delete" do
     let(:plain_hash) { Hash["key" => "value"] }
 

data/spec/spec_helper.rb

@@ -1,4 +1,8 @@
+if ENV['CODECLIMATE_REPO_TOKEN']
+  require "codeclimate-test-reporter"
+  CodeClimate::TestReporter.start
+end
+
 require "minitest/autorun"
-require "minitest/spec"
 
 require "hash_filter"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hash_filter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Peter Suschlik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-22 00:00:00.000000000 Z
+date: 2015-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Filters hashes