ribbon 0.0.5 → 0.1.0

data/lib/ribbon.rb

@@ -1,13 +1,88 @@
 require 'ribbon/methods'
+require 'ribbon/version'
 
 # Ruby Object Notation.
 #
 # Inspired by JSON and OpenStruct.
-module Ribbon
+#
+# Contains a hash whose keys that are symbols can be accessed via method calls.
+# This is done via <tt>method_missing</tt>.
+#
+# In order to make room for as many method names as possible, Ribbon inherits
+# from BasicObject and implements as many methods as possible at the class
+# level.
+class Ribbon < BasicObject
 
-  extend ::Ribbon::Methods
+  extend Methods
 
-end
+  # The internal Hash.
+  def __hash__
+    @hash ||= {}
+  end
 
-require 'ribbon/object'
-require 'ribbon/version'
+  # Merges the internal hash with the given one.
+  def initialize(hash = {}, &block)
+    __hash__.merge! hash, &block
+   ::Ribbon.convert_all! self
+  end
+
+  # Gets a value by key.
+  def [](key)
+    __hash__[key]
+  end
+
+  # Sets a value by key.
+  def []=(key, value)
+    __hash__[key] = value
+  end
+
+  # Handles the following cases:
+  #
+  #   ribbon.method = value  =>  ribbon[method] = value
+  #   ribbon.method!  value  =>  ribbon[method] = value
+  #   ribbon.method?         =>  ribbon[method] ? true : false
+  #   ribbon.method          =>  ribbon[method]
+  def method_missing(method, *args, &block)
+    m = method.to_s.strip.chop.strip.to_sym
+    case method.to_s[-1]
+      when '=', '!'
+        self[m] = args.first
+      when '?'
+        self[m] ? true : false
+      else
+        self[method] = if __hash__.has_key? method
+          ::Ribbon.convert self[method]
+        else
+          ::Ribbon.new
+        end
+    end
+  end
+
+  # Computes a simple key:value string for easy visualization.
+  #
+  # In +opts+ can be specified several options that customize how the string
+  # is generated. Among those options:
+  #
+  # [:separator]  Used to separate a key/value pair. Default is <tt>': '</tt>.
+  # [:key]        Symbol that will be sent to the key in order to obtain its
+  #               string representation. Defaults to <tt>:to_s</tt>.
+  # [:value]      Symbol that will be sent to the value in order to obtain its
+  #               string representation. Defaults to <tt>:inspect</tt>.
+  #
+  # No matter what is given as the key or value of a
+  def to_s(opts = {})
+    ksym = opts.fetch(:key,   :to_s).to_sym
+    vsym = opts.fetch(:value, :inspect).to_sym
+    separator = opts.fetch(:separator, ': ').to_s
+    values = ::Ribbon.map(self) do |k, v|
+      k = if ::Ribbon.instance? k then k.to_s opts else k.send ksym end
+      v = if ::Ribbon.instance? v then v.to_s opts else v.send vsym end
+      "#{k}#{separator}#{v}"
+    end.join ', '
+    "{Ribbon #{values}}"
+  end
+
+  # Same as #to_s.
+  alias :inspect :to_s
+
+end

data/lib/ribbon/core_ext.rb

@@ -1,4 +1,4 @@
-module Ribbon
+class Ribbon < BasicObject
 
   # Optional extensions to the standard library to make life easier.
   module CoreExt; end

data/lib/ribbon/core_ext/hash.rb

@@ -1,6 +1,6 @@
-require 'ribbon/object'
+require 'ribbon'
 
-module Ribbon
+class Ribbon < BasicObject
   module CoreExt
 
     # Includes a method to convert hashes to ribbons.
@@ -8,7 +8,7 @@ module Ribbon
 
       # Converts this hash to a Ribbon::Object.
       def to_ribbon
-        ::Ribbon::Object.new self
+        Ribbon.new self
       end
 
       # Same as #to_ribbon.

data/lib/ribbon/methods.rb

@@ -1,4 +1,4 @@
-module Ribbon
+class Ribbon < BasicObject
 
   # Methods that operate on Ribbons. These should be included at the class level
   # in order to keep as many names available for use with ribbons as possible.
@@ -33,7 +33,7 @@ module Ribbon
       {}.tap do |hash|
         each(ribbon) do |key, value|
           hash[key] = case value
-            when ::Ribbon::Object then to_hash value
+            when Ribbon then to_hash value
             else value
           end
         end
@@ -44,7 +44,7 @@ module Ribbon
     # an Array, converts any hashes inside.
     def convert(object)
       case object
-        when ::Hash then ::Ribbon::Object.new object
+        when ::Hash then Ribbon.new object
         when ::Array then object.map { |element| convert element }
         else object
       end
@@ -54,7 +54,7 @@ module Ribbon
     def convert_all!(ribbon)
       each(ribbon) do |key, value|
         ribbon[key] = case value
-          when ::Ribbon::Object then convert_all! value
+          when Ribbon then convert_all! value
           else convert value
         end
       end
@@ -63,11 +63,20 @@ module Ribbon
 
     # Returns +true+ if the given +object+ is a Ribbon.
     def instance?(object)
-      ::Ribbon::Object === object
+      Ribbon === object
+    end
+
+    # Converts the ribbon to a hash and serializes it with YAML. To get a ribbon
+    # back from the serialized hash, you can simply load the hash and pass it to
+    # the Ribbon::Object constructor:
+    #
+    #   ribbon = Ribbon::Object.new YAML.load(str)
+    def to_yaml(ribbon)
+      to_hash(ribbon).to_yaml
     end
 
   end
 
 end
 
-require 'ribbon/object'
+require 'ribbon'

data/lib/ribbon/version.rb

@@ -1,4 +1,4 @@
-module Ribbon
+class Ribbon < BasicObject
 
   # Ribbon's version.
   module Version
@@ -11,12 +11,12 @@ module Ribbon
     # Minor version.
     #
     # Increments denote backward-compatible changes and additions.
-    MINOR = 0
+    MINOR = 1
 
     # Patch version.
     #
     # Increments denote changes in implementation.
-    PATCH = 5
+    PATCH = 0
 
     # Build version.
     #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ribbon
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rookie
-  requirement: &21981980 !ruby/object:Gem::Requirement
+  requirement: &15229760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21981980
+  version_requirements: *15229760
 description: Ruby Object Notation. Inspired by JSON and OpenStruct.
 email: matheus.a.m.moreira@gmail.com
 executables: []
@@ -38,7 +38,6 @@ files:
 - lib/ribbon/core_ext.rb
 - lib/ribbon/core_ext/hash.rb
 - lib/ribbon/methods.rb
-- lib/ribbon/object.rb
 - lib/ribbon/version.rb
 - ribbon.gemspec
 homepage: https://github.com/matheusmoreira/ribbon

data/lib/ribbon/object.rb

@@ -1,87 +0,0 @@
-require 'ribbon/methods'
-
-module Ribbon
-
-  # Contains a hash whose keys that are symbols or strings can be accessed via
-  # method calls. This is done via <tt>method_missing</tt>.
-  #
-  # In order to make room for as many method names as possible, Ribbon::Object
-  # inherits from BasicObject and implements as many methods as possible at the
-  # class level.
-  class Object < BasicObject
-
-    extend Methods
-
-    # The internal Hash.
-    def __hash__
-      @hash ||= {}
-    end
-
-    # Merges the internal hash with the given one.
-    def initialize(hash = {}, &block)
-      __hash__.merge! hash, &block
-      Object.convert_all! self
-    end
-
-    # Gets a value by key.
-    def [](key)
-      __hash__[key]
-    end
-
-    # Sets a value by key.
-    def []=(key, value)
-      __hash__[key] = value
-    end
-
-    # Handles the following cases:
-    #
-    #   ribbon.method = value  =>  ribbon[method] = value
-    #   ribbon.method!  value  =>  ribbon[method] = value
-    #   ribbon.method?         =>  ribbon[method] ? true : false
-    #   ribbon.method          =>  ribbon[method]
-    def method_missing(method, *args, &block)
-      m = method.to_s.strip.chop.strip.to_sym
-      case method.to_s[-1]
-        when '=', '!'
-          self[m] = args.first
-        when '?'
-          self[m] ? true : false
-        else
-          self[method] = if __hash__.has_key? method
-            Object.convert self[method]
-          else
-            Object.new
-          end
-      end
-    end
-
-    # Computes a simple key:value string for easy visualization.
-    #
-    # In +opts+ can be specified several options that customize how the string
-    # is generated. Among those options:
-    #
-    # [:separator]  Used to separate a key/value pair. Default is <tt>': '</tt>.
-    # [:key]        Symbol that will be sent to the key in order to obtain its
-    #               string representation. Defaults to <tt>:to_s</tt>.
-    # [:value]      Symbol that will be sent to the value in order to obtain its
-    #               string representation. Defaults to <tt>:inspect</tt>.
-    #
-    # No matter what is given as the key or value of a
-    def to_s(opts = {})
-      ksym = opts.fetch(:key,   :to_s).to_sym
-      vsym = opts.fetch(:value, :inspect).to_sym
-      separator = opts.fetch(:separator, ': ').to_s
-      values = Object.map(self) do |k, v|
-        k = if Object.instance? k then k.to_s opts else k.send ksym end
-        v = if Object.instance? v then v.to_s opts else v.send vsym end
-        "#{k}#{separator}#{v}"
-      end.join ', '
-      "{Ribbon #{values}}"
-    end
-
-    # Same as #to_s.
-    alias :inspect :to_s
-
-  end
-
-end