gamera-symbolmatrix 1.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9534cb08aea3a9814730c6157232b713ea3682fe
+  data.tar.gz: 0a0c75fde4ee1a69bb7dc465d0f857fcea0abb42
+SHA512:
+  metadata.gz: c634026a5ec9ee98c243e92be12da9e30370b78fbbd2f5496abd56b16b043268d68b6be88c24bf90ec9951da7862f54584c1e953959d55e9cbdc2ad4faddefe0
+  data.tar.gz: bd829115ecb7b58826f10d6f4de13a590b102c8555affc0fb36eb18c0c85939f311b2e005e23dba410d7d777c58a418c78ad2ab2e7a5fad04a5e5595e6673a91

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,10 @@
+language: ruby
+rvm:
+#  - 1.8.7
+#  - 1.9.2
+  - 1.9.3
+#  - jruby-18mode
+  - jruby-19mode
+#  - rbx-18mode
+  - rbx-19mode
+#  - ree

data/Gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in symbolmatrix.gemspec
+gemspec
+
+# Travis CI me lo pide
+group :test do
+  gem "rake"
+end
+
+group :development do 
+  gem "guard-rspec"
+  gem "guard-cucumber"
+  gem "libnotify"
+  gem "cucumber"
+  gem "pry"
+  gem "rb-inotify"
+end

data/Guardfile

@@ -0,0 +1,39 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :cli => "--color --format doc" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+#  watch('spec/complete_features_helper.rb')  { "spec" }
+#  watch('spec/plain_symbolmatrix_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+
+
+#guard 'cucumber', :cli => "-ci" do
+#  watch(%r{^features/.+\.feature$})
+#  watch(%r{^features/support/.+$})          { 'features' }
+#  watch(%r{^features/stepdefs/(.+)\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'features' }
+#end
+
+guard 'cucumber' do
+  watch(%r{^features/.+\.feature$})
+  watch(%r{^features/support/.+$})          { 'features' }
+  watch(%r{^features/stepdefs/(.+)\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'features' }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Fernando Via
+
+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,201 @@
+_This is a (hopefully temporary) fork of http://github.com/fetcher/symbolmatrix which incorporates some changes from @diminish7 that we need for https://github.com/gamera-team/gamera_
+
+SymbolMatrix
+============
+
+> Strongly inspired in [SymbolTable][symboltable] gem by [Michael Jackson][michael-jackson-home] (thanks a lot!)
+
+> **New!**: SymbolMatrix now features a serialization syntax from which it can be parsed and to which it can be serialized. I'm calling it SMAS (SymbolMAtrix Serialization) and it's loosely inspired in both [rake][rake-link] and [thor][thor-link]'s argument syntax styles. Read more about it in the *SMAS* section downstairs.
+
+**SymbolMatrix** is a simple Ruby Gem that extends `Hash` so that only `Symbol`s can be used as keys. Why? Because it also allows you to query the SymbolMatrix object using the dot syntax and a string key equivalent to the symbol one, making it more Principle of Least Surprise.
+
+The showdown:
+
+```ruby
+h = Hash.new
+h[:a] = 1
+h[:a]       # => 1
+h['a']      # => nil
+h.a         # => NoMethodError: undefined method `a' for {}:Hash
+
+require 'symbolmatrix'
+
+m = SymbolMatrix.new
+m[:a] = 1
+m[:a]       # => 1
+m['a']      # => 1
+m.a         # => 1
+```
+
+If you are familiar with SymbolTable you may have noticed that, so far, the same functionality is provided in the original gem. SymbolMatrix adds three key features:
+
+1.  **Recursive convertion to SymbolMatrix**
+
+    ```ruby
+    require "symbolmatrix"
+
+    m = SymbolMatrix :quantum => { :nano => "data" }
+
+    m.quatum.nano # => "data"
+    ```
+
+2.  **JSON/YAML autoloading**
+
+    ```ruby
+    require "symbolmatrix"
+
+    m = SymbolMatrix "quantum: of solace"
+    m.quantum   # => "of solace"
+
+    # Or alternatively
+    m.from.yaml "quantum: of solace"
+
+    # Provided a file exists "configuration.yaml" with "database_uri: mysql://root@localhost/database"
+    m.from.file "configuration.yaml"
+    m.database_uri  # => "mysql://root@localhost/database"
+
+    # Or simply
+    m = SymbolMatrix "configuration.yaml"
+    ```
+
+    Since all JSON is valid YAML... yey, it works with JSON too!
+	```ruby
+    require 'symbolmatrix'
+
+    data = SymbolMatrix '{"message":"Awesome"}'
+    data.message # => 'Awesome'
+    ```
+
+3.  **Own serialization format for command line**
+
+    Look the next section
+
+[symboltable]: https://github.com/mjijackson/symboltable
+[michael-jackson-home]: http://mjijackson.com/
+[rake-link]: https://github.com/jimweirich/rake
+[thor-link]: https://github.com/wycats/thor
+
+SMAS: SymbolMatrix Serialization
+--------------------------------
+
+The serialization format is designed to serve as an alternative for the command line environment, when multiline (YAML) and special characters (JSON) are not well suited. It's very intuitive and designed to closely resemble the way SymbolMatrix is used within Ruby code. For example:
+
+```ruby
+require 'symbolmatrix'
+
+s = SymbolMatrix 'this.serialization:format i.think:rocks!'
+
+s.this.serialization    # => "format"
+s.i.think               # => "rocks!"
+
+s.from.serialization 'works.with.numbers:793'
+
+s.works.with.numbers    # => 793
+```
+
+You can get the serialization from any SymbolMatrix:
+
+```ruby
+require 'symbolmatrix'
+
+SymbolMatrix(:where => {
+  :is => {
+    :paris  => "france",
+    :roma   => "italia"
+  }
+).to.serialization # => 'where.is.paris:france where.is.roma:italia'
+```
+
+> This serialization format is better exploited in the [Empezar Ruby Gem][empezar-link]
+
+[empezar-link]: https://github.com/Fetcher/empezar
+
+Further details
+---------------
+
+### Recursive `#to.hash` convertion
+
+SymbolMatrix provides the `#to.hash` method that recursively transforms the matrix into a n-dimentional Hash.
+
+### Disabling the extras
+
+If for some reason you don't want this class to use YAML nor the serialization format SMAS, you can just require `symbolmatrix/symbolmatrix` and those functionalities will not be loaded.
+
+### Exceptions
+
+Whenever a key is not found in the SymbolMatrix, a custom `SymbolMatrix::KeyNotDefinedException` will be raised.
+Similarly, if you attempt to use an inconvertible key (inconvertible to `Symbol`) a `SymbolMatrix::InvalidKeyException` will be raised.
+
+Changelog for 1.0.0
+-------------------
+
+Serialization format aside, there had been some minor changes to the API worth noting:
+
+### Deprecations
+
+As of version 1.0.0, Writers and Readers has been added, so now the regular methods `from_yaml`, `from_file` and `to_hash` are deprecated in favor of `from.yaml`, `from.file` and `to.hash`. Please change to the new API is you're working with SymbolMatrix right now.
+
+### `.new` no longer needed
+
+`SymbolMatrix :a => 'b'` is now equivalent to `SymbolMatrix.new(:a => 'b')`.
+
+SymbolMatrix is mostly about the developers having an easier time with code so I place strong priority in these small changes for comfort.
+
+### `#recursive_merge` available
+
+> Note: this is not yet working with any Hash, just SymbolMatrices.
+
+Yey! This one was missing quite a while from Ruby Hashes (if you are like me and spend a lot of time dealing with multidimensional hashes).
+
+The API is straightforward:
+```ruby
+sm = SymbolMatrix(:a => { :b => "c" })
+sm.recursive_merge SymbolMatrix(:a => { :c => "d"})
+
+sm.a.b # => "c"
+sm.a.c # => "d"
+```
+
+Installation
+------------
+
+    gem install symbolmatrix
+
+### Or using Bundler
+Add this line to your application's Gemfile:
+
+    gem 'symbolmatrix'
+
+And then execute:
+
+    bundle install
+
+## Known issues
+
+- When loading a YAML/JSON document that has an sequence –array– as the root item, SymbolMatrix will crash. This is because SymbolMatrix wasn't intended for arrays, just Hashes, and the recursive conversion from Hash to SymbolMatrix is not working with Arrays.
+- Some keys overlap with method names, so can't be used with the dot syntax. For example, `key`. Just use them with the hash syntax instead :)
+
+## Future
+
+- Make SymbolMatrix raise a more relevant error when the file does not exist (something along the lines of "There was an error parsing the YAML string, may be it was a file path and the file does not exist?"). It is possible to increase the chances of detecting properly with a really simple regular expression...
+
+## Testing
+
+RSpec specs are provided to check functionality.
+
+## License
+
+Copyright (C) 2012 Fetcher
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+desc "Run specs"
+RSpec::Core::RakeTask.new(:spec) do |t|
+t.pattern = "./spec/**/*_spec.rb"
+end
+
+task :default => :spec

data/features/parse_serialization.feature

@@ -0,0 +1,26 @@
+Feature: Parsing a SymbolMatrix serialization
+  In order to be able to build multidimensional hashes from 
+    single line contexts, such as terminals
+  As a developer
+  I want to have a simple way to parse a serialization
+
+Scenario: Quite basic structure
+  Given "data:datum"
+  When I parse it
+  Then I should see (serialized in yaml)
+  """
+  data: datum
+  """
+
+Scenario: Needlessly complicated
+  Given "remote.client.host:fetcher remote.client.path:/ remote.client.port:bridge.fetcher remote.server:8080"
+  When I parse it
+  Then I should see (serialized in yaml)
+  """
+  remote: 
+    client:
+      host: fetcher
+      path: /
+      port: bridge.fetcher
+    server: 8080
+  """

data/features/print_to_yaml.feature

@@ -0,0 +1,20 @@
+Feature: Print to YAML
+  I want to be able to print a SymbolMatrix into YAML
+    with a simple Hash format
+
+Scenario: A simple SymbolMatrix
+  Given the SymbolMatrix:
+  """
+  a:
+    simple: symbolmatrix
+    with: data
+  """
+  When I write it to YAML
+  Then I should have
+  """
+  ---
+  a:
+    simple: symbolmatrix
+    with: data
+  
+  """

data/features/serialize.feature

@@ -0,0 +1,43 @@
+Feature: Serializing a SymbolMatrix
+  In order to be able to send SymbolMatrices
+    in command line environments
+  As a developer
+  I want to be able to serialize SymbolMatrices
+
+Scenario: Nice SymbolMatrix serialized
+  Given the SymbolMatrix:
+  """
+  roses:
+    are: red
+  violets:
+    are: blue
+  I:
+    get: joke
+    like: poetry
+    say: 
+      to: you
+      some: stuff
+  """
+  When I serialize it
+  Then I should get "roses.are:red violets.are:blue I.get:joke I.like:poetry I.say.to:you I.say.some:stuff"
+
+Scenario: Serializing and parsing back
+  Given the SymbolMatrix:
+  """
+  greetings:
+    aloha: hawaii
+  cities:
+    roma: italy
+    paris: france
+  """
+  When I serialize it
+  Then I should get "greetings.aloha:hawaii cities.roma:italy cities.paris:france"
+  When I parse it
+  Then I should see (serialized in yaml)
+  """
+  greetings:
+    aloha: hawaii
+  cities:
+    roma: italy
+    paris: france
+  """

data/features/stepdefs/parse_serialization.rb

@@ -0,0 +1,11 @@
+Given /^"(.+?)"$/ do |serialization|
+  @serialization = serialization
+end
+
+When /^I parse it$/ do 
+  @parsed = SymbolMatrix.new @serialization
+end
+
+Then /^I should see \(serialized in yaml\)$/ do |data|
+  @parsed.to.hash.should include SymbolMatrix.new(data).to.hash
+end

data/features/stepdefs/print_to_yaml.rb

@@ -0,0 +1,7 @@
+When /^I write it to YAML$/ do 
+  @yaml = @symbolmatrix.to.yaml
+end
+
+Then /^I should have$/ do |yaml|
+  @yaml.should == yaml
+end