static-struct 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e58bdb362d9c46a43ff1ddf194ba0208f9fd002
-  data.tar.gz: 2d4a74628040029118bf154ebdd7b9feae65deb0
+  metadata.gz: 82798250f06d7fb357a049c10b48f54dc1a02416
+  data.tar.gz: 28616d06bb7579ddfd4faf15bd5f1c49114786c9
 SHA512:
-  metadata.gz: 3d0e87d286cb8d5a0f2a4aa21579c27600729ea04453ee3c57247aacf4ac5de82e85ed9b363a0dcd64e5d28d5f1ed865224bcef4c0a203f8c09df41c72ff6b2a
-  data.tar.gz: 5ca9c3d0bcdf17fc107ef0a434a8e33b0e2e71e9e0adbbf7cef7556be180a089aba0bcef4b34fdd0e347e5d12c55226623ecc173dbc8c4adad3e7a5fe0dbaa8e
+  metadata.gz: 18637a10c2787c7639dacbb7aa5794752145cf4d1398cec4fd929c99e0ffe1a31404936706dc15e0301a700710a4982e4f5a9828d35c795914deb5e271fabfbc
+  data.tar.gz: 08536c69db61880fb9451361e5a6f3e9b181bb038552108a891506612fe1cdf584781c0de2a36f27c933e17502327b208c74ae0e8899b59b523afe8e17d1df3b

data/README.md

@@ -6,7 +6,7 @@ Convert Ruby hashes (or hash-like objects) into Ruby objects.
 
 Key features:
 
-* Nesting hashes and respond to objects `to_hash` methods are allowed to do the convertation;
+* Nesting hashes and respond to objects `to_hash` methods are allowed to do the conversation;
 * There are no limitations of the nesting;
 * It is not possible to call undefined methods;
 * The defined dynamically structure is iterable (responds to `each`);
@@ -14,7 +14,7 @@ Key features:
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application's `Gemfile`:
 
 ```ruby
 gem 'static-struct', require 'static_struct'
@@ -52,6 +52,39 @@ struct.enum_for(:each).map do |key, val|
 end # => [["foo", "bar"], ["foo_foo", #<Enumerator: #<StaticStruct::Structure foo = bar>:each>]]
 ```
 
+## Motivation
+
+What the problem solves the gem? Well, it's very straightforward to explain. Lately we are facing the issues
+that covert Ruby objects into JSON in order to respond it to the client more often. It's rather easy task
+and may be solved without any third-party libraries. Commonly the Ruby objects are transformed into
+`Hash`'es and then - into JSON. The client side receives the formed JSON and in JavaScript (as usual)
+we are free to use the JSON properties via `.` call (`{foo: 'bar'}` can be called as `foo.bar`).
+
+Getting properties via `.` notation is more convenient in JavaScript versus getting them via `[]`.
+But in Ruby it's more robust and safe in addition to the convenience. That means, it's not possible
+to call undefined methods in Ruby. We just get exceptions with well explained messages in such cases.
+And this is cool - having early exceptions in our Ruby code makes application bug free, allows to
+reduce debugging time when something goes wrong. As more code with incorrect state we have in Ruby as
+more we spend time in debugging. But debugging Ruby code is awful and should be reduced.
+
+Ok, we have peace of code on the server side that generates `Hash` with necessary structure for the client side.
+But later we need to send emails based on the same structure as the client renders `HTML`. Commonly
+emails are rendered on the server side and that means that we have a dilemma here: from one side we
+could use the generated `Hash` there but this is not a convenient and robust solution as we already
+figured out; from other side we could transform the `Hash` into a Ruby objects structure, that's
+correct solution but the problem is that there is no a good ready library for this. So, here this gem comes
+to the help. It allows to create a robust Ruby objects structure given the `Hash`.
+
+Others say that we could use [ostruct](http://ruby-doc.org/stdlib-2.0.0/libdoc/ostruct/rdoc/OpenStruct.html) or [hashie](https://github.com/intridea/hashie) in order to solve the problem. But they don't solve one
+important issue - when there is no defined property on the structure there should be an **exception**.
+Only this way we make a profit reducing bugs and debugging time.
+
+As you noticed the library creates an immutable Ruby objects structure, all the state is holding
+in methods, there are no variables for the generating methods. This is made intentionally in order to
+reduce having incorrect states of the generated Ruby structure. As you see the structure is assumed
+to be used only for read-only purpose. But if you have some circumstances where we need to change the
+state feel free to open an issue for the discussion.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/static-struct.rb

@@ -0,0 +1 @@
+require 'static_struct'

data/lib/static_struct/structure.rb

@@ -6,7 +6,7 @@ module StaticStruct
 
     def initialize(hash)
       @static_methods = SortedSet.new
-      define_structure(self, hash)
+      define_structure(hash)
     end
 
     def to_s
@@ -41,21 +41,21 @@ module StaticStruct
 
     private
 
-    def define_structure(parent, hash)
+    def define_structure(hash)
       Hash(hash).each do |key, val|
-        safe_define_method(parent, key, val)
+        safe_define_method(key, val)
       end
     end
 
-    def safe_define_method(object, method, return_value)
-      if object.respond_to?(method)
-        fail MethodAlreadyDefinedError, "`#{method}' is already defined for #{object}"
+    def safe_define_method(method, return_value)
+      if respond_to?(method)
+        fail MethodAlreadyDefinedError, "`#{method}' is already defined for #{self}"
       end
 
-      object.static_methods.add(method.to_s)
+      static_methods.add(method.to_s)
       case
       when return_value.is_a?(Array)
-        object.define_singleton_method(method) do
+        define_singleton_method(method) do
           return_value.map do |array_value|
             if array_value.respond_to?(:to_hash)
               Structure.new(array_value)
@@ -65,11 +65,11 @@ module StaticStruct
           end
         end
       when return_value.is_a?(Hash)
-        object.define_singleton_method(method) { Structure.new(return_value) }
+        define_singleton_method(method) { Structure.new(return_value) }
       when return_value.respond_to?(:to_hash)
-        object.define_singleton_method(method) { Structure.new(Hash(return_value)) }
+        define_singleton_method(method) { Structure.new(Hash(return_value)) }
       else
-        object.define_singleton_method(method) { return_value }
+        define_singleton_method(method) { return_value }
       end
     end
   end

data/lib/static_struct/version.rb

@@ -1,3 +1,3 @@
 module StaticStruct
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: static-struct
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Mezuka LLC
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-18 00:00:00.000000000 Z
+date: 2016-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,6 +70,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/static-struct.rb
 - lib/static_struct.rb
 - lib/static_struct/method_already_defined_error.rb
 - lib/static_struct/structure.rb