arendelle 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0fb231fcd2a2f086f85f741c07876da50d59e87
-  data.tar.gz: beabf2e1a62170c754cb5b719c153a76e1e8f26c
+  metadata.gz: b8c4731aa741a8c2c04710d88dd8c765def58bc0
+  data.tar.gz: 450779ee96a563356f0157d997c76965dd2b76ca
 SHA512:
-  metadata.gz: b943a00e6d4dce73cb276cfa9600c7b55bbb5194d0b96a3c0ca713c187936baeae19f36fd1ac9972d6f2c6b64ed19ac453530f88503d54570a644d5dc4f3a9f7
-  data.tar.gz: 84819e6c0d2c6f3bb4243f52c1f0db12cc6cc2f576c296f057c91801ea8749071ae94ddfb6d2710a348c93a1a5bf91aaf4c66665e11d84093fd7e3fc403cfd22
+  metadata.gz: 2316e611e4cd8a45930b5071a608e154570aeb7bf31bc6516c4c2ddd13815389cc6a5052729b961f4259ea63f1754d5899942cd97b8bbf9ab239e59058c6ce1a
+  data.tar.gz: 7f61c21e719c80d55398c5c76622d6fee69355ffaec1383b277de9daba175846a70139e653d3d41784440fe9a6d5974916cbb57b948b47424f427831927fead6

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## [0.1.1] - 2017-03-20
+
+Added support for handling JSON keys that start with integers. Previously this was attempting to use an invalid instance variable ("@1234"). New behavior prepends instance variables and method access calls with an underscore: `obj._1234` or `obj.instance_variable_get("_@1234")`.
+
+## [0.1.0] - 2017-03-06
+
+Initial version released.

data/README.md

@@ -1,10 +1,20 @@
 # Arendelle
 
-Arendelle is a small gem with a distantly semantic name, used for initializing mostly frozen objects. If you've got kids, you probably already understand.
+Arendelle is a small gem with a distantly semantic name, used for initializing mostly frozen objects. If you've got kids, you probably already understand the name.
 
 ## Why?
 
-We primarily use Arendelle in our innternal projects combined with JSON.parse and the `object_class` setting, to initialize (mostly) frozen objects. This helps prevent accidentally mutating the state of a parsed JSON file or configuration class, while providing a javascript object-like interface for accessing deeply nested settings. See usage for more details.
+There are a ton of great Struct-like libraries that focus on immutable values. Some (`ure`, for example) focus on performance and offer a similar interface to Struct for declaring dynamic classes. Others give you the full kitchen sink - featuring any type of object you need, with immutability built in.
+
+Our use case was very simple, and yet we found ourselves repeatedly reaching for the same code snippet across multiple projects. We wanted something that offers a simple interface for initializing objects when using JSON.parse (which relies on `[]=` as a setter) or something we could occasionally use as a simple set-it-and-forget-it type of simple PORO.
+
+So we built something lightweight, optimized for our current use case: `JSON.parse(json_string, object_class: Arendelle)`. When combined with JSON.parse it builds a clean javascript-object like interface for accessing deeply nested JSON, and for us, removed any concerns about "extra" things the code was doing.
+
+Take a look at the source for yourself: you probably don't need our help to write this gem. The surface area is incredibly small. But given the utility we've found using this lib, we figured it couldn't hurt to put it out there. So, here you go, Internet. Enjoy.
+
+**tl;dr**
+
+Arendelle helps prevent accidentally mutating the state of a parsed JSON file or configuration class, while providing a javascript object-like interface for accessing deeply nested settings (when used in conjunction with `JSON.parse`). See usage for more details.
 
 ## Installation
 
@@ -24,11 +34,44 @@ Or install it yourself as:
 
 ## Usage
 
+```ruby
+  json = '{"user_settings":{"name":"Rob"}}'
+  obj = JSON.parse(json, object_class: Arendelle)
+
+  obj.user_settings.name
+    => "Rob"
+
+  # Variables are frozen after initialization
+  obj.user_settings["name"] = "New Name"
+    => FrozenVariableError: "Cannot modify frozen variable"
+
+  # Values are frozen after being set
+  name = obj.user_settings.name
+  name << "Test"
+    => RuntimeError: "can't modify frozen String"
+    
+  # We call these mostly frozen objects, because they aren't 100% immutable: they can have settings added, but not modified
+  newobj = Arendelle.new(key1: "value1")
+  newobj.key1
+    => "value1"
+
+  newobj["key2"] = "value2"
+  newobj.key2
+    => "value2"
+
+  newobj["key1"] = "value3"
+    => FrozenVariableError: "Cannot modify frozen variable"
 ```
+
+```yaml
 # api_keys.yml
 defaults: &defaults
   cool_service:
     client_secret: <%= ENV["COOL_SERVICE_CLIENT_SECRET"] || "default_value" %>
+```
+
+```ruby
+# Snippet from our "real-world" use case. For us, this is a replacement for the SettingsLogic gem.
 
 # settings.rb
 class Settings
@@ -48,7 +91,7 @@ class Settings
 end
 ```
 
-```
+```ruby
 Settings.cool_service.client_secret
   => "default_value" # assuming the ENV var isn't set
 ```
@@ -59,6 +102,12 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+## Wishlist
+
+Currently, we're using this in conjunction with JSON.parse. In some situations, this is less than ideal, as we will rely on the recursive behavior of JSON.parse to ensure that each object is initialized appropriately - calling it as `JSON.parse({}.to_hash, object_class: Arendelle)` - which is one step too many.
+
+Adding a `.build_from_hash` type of class method which efficiently handles recursively transforming hash isn't something we need often, but would be a nice-to-have.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/arendelle. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/lib/arendelle.rb

@@ -1,18 +1,24 @@
 class Arendelle
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 
   def initialize(**opts)
     opts.each { |k, v| self[k] = v }
   end
 
   def []=(key, value)
-    ivar = "@#{key}"
+    ivar = "@_#{key}"
     raise FrozenVariableError if instance_variable_get(ivar)
 
     instance_variable_set(ivar, value.freeze)
 
-    define_singleton_method(key) do
-      instance_variable_get(ivar)
+    if key[0] =~ /\d/
+      define_singleton_method("_#{key}") do
+        instance_variable_get(ivar)
+      end
+    else
+      define_singleton_method(key) do
+        instance_variable_get(ivar)
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arendelle
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Rob Cole
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-06 00:00:00.000000000 Z
+date: 2017-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -62,12 +62,12 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- arendelle.gemspec
 - bin/console
 - bin/setup
 - lib/arendelle.rb

data/arendelle.gemspec

@@ -1,27 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'arendelle'
-
-Gem::Specification.new do |spec|
-  spec.name          = "arendelle"
-  spec.version       = Arendelle::VERSION
-  spec.authors       = ["Rob Cole"]
-  spec.email         = ["robcole@useed.org"]
-
-  spec.summary       = %q{A simple gem for creating mostly frozen objects.
-                          Useful for configuration-like objects.}
-  spec.homepage      = "https://github.com/useed/arendelle"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.14"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-end