hashing 0.0.1.beta.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bd1eb92fa4ef69893588e90462ba6671051ce607
+  data.tar.gz: 22ce96b6cb54a66f481a0f8ecfeda9337e908353
+SHA512:
+  metadata.gz: 008576591fcb187f2bb97ac1524e6c52f13359e814cd8a0370899581c6c2186e45516293ee9de51544fd17caa1fd6854d73bc27535243f87881d86b1c67f6fb1
+  data.tar.gz: 1d37ef8ac7bfd7ffc832add6c6fa0ab754ee5a8079eadaa27bf239008867a73a3eed83637b1a2c63152e30f4dd198f7f42576ca2f3d24f17d9c261007dde9828

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ricardo Valeriano
+
+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,210 @@
+# Hashing
+
+Permits you to say which instance variables of your objects should be used to
+serialize it into a `Hash`. Gives you a nice way to inform this, and facilitates
+to recreation of your serializable objects from hashes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hashing'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hashing
+
+## Usage
+
+Given a `File` class like this:
+
+```ruby
+class File
+  def initialize(path, commit = nil, content = nil)
+    @path, @commit, @content = path, commit, content
+  end
+end
+```
+
+And I want to turn instances of it in a `Hash` like the one below, so I can, for
+example, turn this `Hash` into a `YAML` to save it in a file.
+
+```ruby
+{
+  path: @path,
+  commit: @commit,
+  content: @content
+}
+```
+
+I just need to include the `Hashing` module, and then indicates which
+`instance vars` (`ivars`) should be used in the serialization using the class
+method `hasherize`:
+
+```ruby
+class File
+  include Hashing
+  hasherize :path, :commit, :content
+end
+```
+
+### #to_h
+
+Then I will be able to call the `#to_h` method in any instance of `File` to
+obtain the "hasherized®" version of it:
+
+```ruby
+file = File.new 'README.md', 'cfe9aacbc02528b', '#Hashing\n\nWow. Such code...'
+
+file.to_h
+# {
+#   path: 'README.md',
+#   commit: 'cfe9aacbc02528b',
+#   content: '#Hashing\n\nWow. Such code...'
+# }
+```
+
+### ::from_hash
+
+And I can tell `Hashing` how one can create an instance of `File` given a
+valid `Hash` like the one created by a `#to_h` call:
+
+```ruby
+class File
+  include Hashing
+  hasherize :path, :commit, :content
+
+  from_hash ->(hash) {
+    new hash[:path], hash[:commit], hash[:content]
+  }
+
+  # ...
+end
+```
+
+So I can transform instances of any Ruby class into hashes and rebuild objects
+of any type from hashes, accordingly with my business rules, without expose
+these rules outside my classes.
+
+Note that both `#to_h` and `::from_hash` methods are public, and you can and
+should call them whatever you need in your programs. But the `::from_hash`
+method will be called by `Hashing` when building your instances from hashes (more
+about this: [nested hasherizing](#nested-hasherized-objects)).
+
+#### Hasherize
+
+`Hashing` comes with an alternative way to indicate what fields should be used to
+represent your objects as a `Hash`. This can be done by the `Hasherize` class.
+The previous example can be writen like this:
+
+```ruby
+class File
+  include Hasherize.new :path, :commit, :content
+
+  from_hash ->(hash) {
+    new hash[:path], hash[:commit], hash[:content]
+  }
+
+  # ...
+end
+```
+
+It's just a matter of taste. Use the one that is more appealing to you.
+
+### Custom "hasherizing" and loading strategies
+
+Many times you will need apply some computation over the contents of your
+`ivars` transform them in a primitive that can be stored as a `Hash`.
+
+Following the `File` class example, maybe you want to store the `@content` as a
+`Base64` enconded string.
+
+`Hashing` allows you to specify the strategy of serialization and loading when
+indicating which `ivars` should be part of the final `Hash`:
+
+```ruby
+require 'base64'
+
+class File
+  include Hashing
+
+  hasherize :path, :commit
+
+  hasherize :content,
+    to_hash: ->(content) { Base64.encode64 content },
+    from_hash: ->(content_string) { Base64.decode64 content_string }
+
+  from_hash ->(hash) {
+    new hash[:path], hash[:commit], hash[:content]
+  }
+
+  # ...
+end
+```
+
+
+#### Nested hasherized objects
+
+But if your transformations are a little more complicated than a simple `Base64`
+encoding, chances are there that you have a nested objects to be serialized.
+
+Extending our example, maybe our `File` class have an internal collection of
+`Annotation`, to allow the user to indicate what is in which line of a file:
+
+```ruby
+# annotation.rb
+
+class Annotation
+  include Hasherize.new :lines, :annotation
+
+  def initialize(lines, annotation)
+    @lines = lines
+    @annotation = annotation
+  end
+end
+```
+
+And the `File` class could have a method to add new annotations:
+
+```ruby
+# file.rb
+
+class File
+  # ...
+
+  def annotate(lines, annotation)
+    @annotations ||= []
+    @annotations << Annotation.new(lines, annotation)
+  end
+  # ...
+end
+```
+
+So in this case, if you wants a file to be `hasherized®` with it's internall
+`@annotations` preserved, you just indicate this in the `File` class. The
+example now can be rewriten as:
+
+```ruby
+class File
+  include Hashing
+
+  hasherize :path, :commit, :annotations
+
+  # ...
+end
+```
+
+Since the `Annotation` class has it's own notion of `#to_h` and `::from_hash`,
+this is all that `Hashing` needs to build a `File` instances from a valid `Hash`.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/hasher/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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/hashing.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hashing/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hashing"
+  spec.version       = Hashing::VERSION
+  spec.authors       = ["Ricardo Valeriano"]
+  spec.email         = ["ricardo.valeriano@gmail.com"]
+  spec.summary       = %q{Serialize your objects as Hashes}
+  #spec.description   = %q{TODO: Write a longer description. Optional.}
+  spec.homepage      = "http://github.com/ricardovaleriano/hashing"
+  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_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/lib/hashing.rb

@@ -0,0 +1,5 @@
+require "hashing/version"
+
+module Hashing
+  # Your code goes here...
+end

data/lib/hashing/version.rb

@@ -0,0 +1,3 @@
+module Hashing
+  VERSION = "0.0.1.beta.2"
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: hashing
+version: !ruby/object:Gem::Version
+  version: 0.0.1.beta.2
+platform: ruby
+authors:
+- Ricardo Valeriano
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: 
+email:
+- ricardo.valeriano@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hashing.gemspec
+- lib/hashing.rb
+- lib/hashing/version.rb
+homepage: http://github.com/ricardovaleriano/hashing
+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.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Serialize your objects as Hashes
+test_files: []