sd_struct 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db8247a8652fb98a73e935ce9c0737d3bcb60aeb
-  data.tar.gz: e681ebbbe672b041dbe2d84e7e819123c7bfd966
+  metadata.gz: 3b7a67f6e73b67288c75959f12b9c28557326ef7
+  data.tar.gz: 0e4dc23fda1637c672516f58aad9e79e8492b1b9
 SHA512:
-  metadata.gz: a46da494946f552eca4dc1912c1d6f96667f933539b9fe4f66d37f530600f52e6e508c7a9c26a4d541f71c433af85dd890008bef1b231af98fe8d30878027b03
-  data.tar.gz: 3987632b1425ef16c1535a740ac68183170a644b9b1122e14ac3e2eab9c9d24c6745c357e957e5fe2266ef452f9a8a172e7bd097afeb9f8c5b2ab96b7c942837
+  metadata.gz: 1ac85d00a9d591074e27c9174cfb100cbdb220752060b8f811bf5c0d71d4acb357f91eef2bd7f6480c8b8529be51720898dd1e2d055b430d0be6a935fffa35c6
+  data.tar.gz: 58fa6f524bde91f41511e78d561eb829e746d8564965c136bf91c8462b5c4cdd835889a79894e4b41b43a00fdfc8f86a568affdb63dfc7d250d478de415bd2a6

data/README.md

@@ -71,13 +71,13 @@ sd_struct.to_h
 ```
 
 
-> OpenStruct uses `method_missing` to create new field, while SDStruct prevent creation
-> of new field using dot notation.
+> OpenStruct allows creation of a new field with dot notation while SDStruct
+> prevents it
 
-SDStruct prevent creation of new field using dot notation once it is initialized
-to prevent assigning unintended field when you mistyped the key/field. SDStruct
-is stricter in that way. However, SDStruct can also be lenient. You can use
-square brackets when you want to assign a new field.
+SDStruct disallows creation of a new field using dot notation to prevent
+assigning unintended field when you mistyped the key/field. SDStruct is
+stricter in that way. However, SDStruct can also be lenient. You can use square
+brackets when you want to assign a new field.
 
 ```ruby
 ## OpenStruct
@@ -114,10 +114,10 @@ sd_struct.find('/array/0/one')
 sd_struct.find('object->a', separator: '->')
 # => "bau bau"
 
+# You can push it to find deeper. It will return the first occurrence of the matched field
 sd_struct.find('.array..one', separator: '.')
 # => 1
 
-# You can push it to find deeper. It will return the first occurrence of the matched field
 sd_struct.find('//a')
 # => "bau bau"
 
@@ -274,6 +274,19 @@ that doesn't have deep search and deep convert capabilities.
 require 'sd_struct/base'
 ```
 
+## Attribution
+
+OpenStruct is used as the base of this project.
+
+
+## TODO
+
+  * Add specs
+  * Add `method_missing` to define singleton method when a field/member/key is
+    called (and not during initialization) to execute initialization faster
+  * Reimplement SDStruct to extend Hash (possibly will make it faster)
+
+
 ## Contributing
 
 1. Fork it ( https://github.com/styd/sd_struct/fork )

data/lib/sd_struct/base.rb

@@ -6,7 +6,7 @@ class SDStruct
   using Module.new {
     refine Hash do
       #
-      # Change current Hash object to SDStruct object
+      # Changes current Hash object to SDStruct object
       #
       # @return [SDStruct] SDStruct object
       #
@@ -16,9 +16,8 @@ class SDStruct
     end
 
     refine Array do
-
       #
-      # Call `to_struct` to an Array to go deeper or to a Hash to change it to SDStruct
+      # Calls `to_struct` to an Array to go deeper or to a Hash to change it to SDStruct
       #
       # @return [Array<SDStruct,Object>] array of SDStruct or any other objects
       #
@@ -42,18 +41,23 @@ class SDStruct
   #
   #   p data # -> #<SDStruct .name="Matz", ['coding language']=:ruby, .age="old">
   #
-  def initialize(hash = nil, deep = true)
-    @deep = deep
+  def initialize(hash = nil, opts = {})
+    opts = {
+      deep:           true,
+      symbolize_keys: true
+    }.merge(opts)
+
+    @deep = opts[:deep]
     @table = {}
     if hash
       hash.each_pair do |k, v|
-        @table[new_struct_member(k)] = structurize(v) # @deep is used in this method
+        @table[naturalize(k)] = structurize(v) # @deep is used in this method
       end
     end
   end
 
   #
-  # Duplicate an SDStruct object members.
+  # Duplicates an SDStruct object members.
   #
   def initialize_copy(orig)
     super
@@ -92,7 +96,6 @@ class SDStruct
   # Used internally to define field properties
   #
   def new_struct_member(name)
-    name = name.to_s.underscore.to_sym unless name[/^[A-Z]|\s+/]
     unless respond_to?(name)
       define_singleton_method(name) { @table[name] }
       define_singleton_method("#{name}=") { |x| @table[name] = x }
@@ -100,14 +103,22 @@ class SDStruct
     name
   end
 
+  def naturalize(key)
+    unless key[/^[A-Z]|\s+/]
+      key.to_s.underscore.to_sym
+    else
+      key
+    end
+  end
+
   #
-  # Call to struct to a value if it is an Array or a Hash and @deep is true
+  # Calls to struct to a value if it is an Array or a Hash and @deep is true
   #
   def structurize(value)
     ( @deep && (value.is_a?(Hash) || value.is_a?(Array)) ) ? value.to_struct : value
   end
 
-  protected :new_struct_member, :structurize
+  protected :new_struct_member, :naturalize, :structurize
 
 
   #
@@ -117,7 +128,7 @@ class SDStruct
   #   person[:lang] # => ruby, same as person.lang
   #
   def [](name)
-    @table.has_key?(name) ? @table[name] : @table[name.to_s.underscore.to_sym]
+    @table[name] || @table[naturalize(name)]
   end
 
   #
@@ -128,21 +139,19 @@ class SDStruct
   #   person.lang # => ruby
   #
   def []=(name, value)
-    unless self.[](name).nil? || value.is_a?(self.[](name).class)
+    unless self[name].nil? || value.is_a?(self[name].class)
       warn("You're assigning a value with different type as the previous value.")
     end
-    @table[new_struct_member(name)] = structurize(value)
+    @table[new_struct_member(naturalize(name))] = structurize(value)
   end
 
-  InspectKey = :__inspect_key__ # :nodoc:
-
   #
   # Returns a string containing a detailed summary of the keys and values.
   #
   def inspect
     str = "#<#{self.class}"
 
-    ids = (Thread.current[InspectKey] ||= [])
+    ids = (Thread.current[:sd_struct] ||= [])
     if ids.include?(object_id)
       return str << ' ...>'
     end
@@ -181,7 +190,7 @@ class SDStruct
   end
 
   #
-  # Compute a hash-code for this SDStruct.
+  # Computes a hash-code for this SDStruct.
   # Two hashes with the same content will have the same hash code
   # (and will be eql?).
   #
@@ -190,14 +199,14 @@ class SDStruct
   end
 
   #
-  # Expose keys with space(s)
+  # Exposes keys with space(s)
   #
   def spaced_keys
     @table.keys - non_spaced_keys
   end
 
   #
-  # Expose keys without space(s)
+  # Exposes keys without space(s)
   #
   def non_spaced_keys
     methods(false).select{|x| x[/^\S+[^=]$/]}
@@ -205,21 +214,34 @@ class SDStruct
   alias :fields :non_spaced_keys
 
   #
-  # Expose all keys
+  # Exposes all keys
   #
   def keys
     @table.keys
   end
 
   #
-  # Delete specified field or key
+  # Deletes specified field or key
   #
   def delete_field(name)
-    sym = name.to_sym
-    @table.delete(sym) do
-      raise NameError.new("no field `#{sym}' in #{self}", sym)
+    name = @table.has_key?(name) ? name : naturalize(name)
+    @table.delete(name) do
+      raise NameError.new("no field `#{name}' in #{self}", name)
     end
-    singleton_class.__send__(:remove_method, sym, "#{sym}=")
+    singleton_class.__send__(:remove_method, name, "#{name}=")
   end
   alias :delete_key :delete_field
+
+  def method_missing(m_id, *args)
+    m_nat = naturalize(m_id)
+    if args.length.zero?
+      if @table.key?(m_nat)
+        @table[new_struct_member(m_nat)]
+      end
+    else
+      err = NoMethodError.new "undefined method `#{m_id}' for #{self}", m_id, args
+      err.set_backtrace caller(1)
+      raise err
+    end
+  end
 end

data/lib/sd_struct/deep_search.rb

@@ -3,7 +3,7 @@ class SDStruct
     refine Array do
 
       #
-      # Dig deep into array until non-Array and non-Hash primitive data is found
+      # Digs deep into array until non-Array and non-Hash primitive data is found
       #
       # @param [Symbol] multiple symbols
       # @return [String,Integer,Float,Boolean,nil] first matched result
@@ -32,7 +32,7 @@ class SDStruct
   }
 
   #
-  # Dig deep into Hash until non-Array and non-Hash primitive data is found
+  # Digs deep into Hash until non-Array and non-Hash primitive data is found
   #
   # @param [Symbol] multiple symbols
   # @return [SDStruct,Hash,Array,String,Integer,Float,Boolean,nil] first matched result
@@ -60,7 +60,7 @@ class SDStruct
   end
 
   #
-  # Dig the content of @table which is a hash
+  # Digs the content of @table which is a hash
   #
   # @param [Symbol] multiple symbols
   # @return [SDStruct,Hash,Array,String,Integer,Float,Boolean,nil] first matched result
@@ -69,6 +69,13 @@ class SDStruct
     @table.dig(*args)
   end
 
+  #
+  # Finds value with keys specified like xpath
+  #
+  # @param [String] key string
+  # @param [Hash] option Hash
+  # @return [SDStruct,Hash,Array,String,Integer,Float,Boolean,nil] first matched result
+  #
   def find(key_str, opts = {})
     opts = {
       separator: "/"
@@ -86,7 +93,7 @@ class SDStruct
                    if !!x[/\A[-+]?\d+\z/]
                      x.to_i
                    else
-                     if x[/^$|\s+/]
+                     if x[/^$|^[A-Z]|\s+/]
                        x
                      else
                        x.underscore.to_sym

data/lib/sd_struct/version.rb

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

data/sd_struct.gemspec

@@ -24,4 +24,5 @@ with deep digging capabilities.}
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.5"
+  spec.add_development_dependency "pry", "~> 0.10.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sd_struct
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Adrian Setyadi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-19 00:00:00.000000000 Z
+date: 2017-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
 description: |-
   An alternative to OpenStruct that more strict in assigning values and deeper in
   consuming the passed Hash and transforming it back to Hash or JSON, equipped