bogo 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b544e3d18be2de80a851293f139ef363d3e2460
-  data.tar.gz: 2634b067067e337a84006f5583263cbb18399930
+  metadata.gz: 03ed553a2ed1b83be48e18aeb962196071a2bb5d
+  data.tar.gz: b1466ec5ade9a0317e57a4e9999d1f8448051bd4
 SHA512:
-  metadata.gz: 7c2f47cfac15a3cbcb72bd8e4d74dc2e2954512f7c8b4afff66624133eb5dfc93afaf2c16db37278cb38e4ff375fd632c8f2ec63fba83403f924f17139133f4d
-  data.tar.gz: d5df748c23547d30bf5db35672c94bb489cfabbaf35125870a451e3c5dc6eb4e038358e7831deb0a7623d3706884e9ea312329acb281be7393bf36f86cf23bba
+  metadata.gz: 230d6b4ca8471a43489d7abe9f1bc883c6a71f20ca1b451103b54b72e1e881fba012a6b2239468c0b6a1005e155aabae0d98886f8d2187a199c9e9cde0bb4774
+  data.tar.gz: 850f441d6b9e1a42f066149dbd06cd70208b3405f040a4f30939e22d9c6e54bdb284bb68f0ad8039733372310a19e364773fbf082aa993652defbc2573e9da22

data/CHANGELOG.md

@@ -1,2 +1,8 @@
+## v0.1.2
+* Add initial spec coverage
+* Always load `Bogo::Smash`
+* Add support for global memoization
+* Auto default lazy data on init
+
 ## v0.1.0
 * Initial release

data/README.md

@@ -1,6 +1,213 @@
 # Bogo
 
-A collection of libraries.
+A collection of helper libraries. What's in the box:
+
+## Animal strings
+
+Convert camel cased strings to snake case or snake cased strings
+to camel case:
+
+```ruby
+require 'bogo'
+
+class Stringer
+  include Bogo::AnimalStrings
+end
+
+str = Stringer.new
+puts str.snake('CamelCasedString')
+puts str.camel('snake_cased_string')
+```
+
+## Smash
+
+Extension of the Hash class. It makes use of the `hashie` library and
+adds a few extra features as well:
+
+Included hashie modules:
+
+* Hashie::Extensions::IndifferentAccess
+* Hashie::Extensions::MergeInitializer
+* Hashie::Extensions::DeepMerge
+* Hashie::Extensions::Coercion
+
+Added extras:
+
+### Conversion
+
+Will convert from `Hash` to `Smash`. This conversion includes `Hash`
+types found within `Array`s:
+
+```ruby
+require 'bogo'
+
+inst = {:a => 1, 'b' => 2, :c => [{:z => true}]}.to_smash
+puts inst[:a]
+puts inst['c'].first['z']
+```
+
+and we can convert from `Smash` to `Hash` as well:
+
+```ruby
+require 'bogo'
+
+inst = {:a => 1, 'b' => 2, :c => [{:z => true}]}.to_smash
+puts inst.class
+puts inst[:c].first.class
+inst = inst.to_hash
+puts inst.class
+puts inst['c'].first.class
+```
+
+### Path Walking
+
+Values can be returned if given a path. If the path does not exist
+a `nil` will be return instead of raising an exception:
+
+```ruby
+require 'bogo'
+
+inst = Smash.new(:a => {:b => {:c => {:d => 1}}})
+puts inst.get(:a, :b, :c, :d)
+puts inst.get(:a, :c, :x, :z)
+```
+
+### Default value on missing path
+
+Use `#fetch` to provide default value if path does not exist. The
+last value in the list will be used as the returned value:
+
+```ruby
+require 'bogo'
+
+inst = Smash.new(:a => 1)
+puts inst.fetch(:b, :c, 2)
+```
+
+### Set value at path
+
+Set deeply nested values by providing the path. The last value
+in the list will be set:
+
+```ruby
+require 'bogo'
+
+inst = Smash.new
+inst.set(:a, :b, :c, :d, :e, 1)
+puts inst.get(:a, :b, :c, :d, :e)
+```
+
+### Checksums
+
+Checksum will generate a new `Smash` instance with sorted keys
+and then generate a SHA256 digest:
+
+```ruby
+require 'bogo'
+
+puts Smash.new(:a => 1, :b => 2, :c => 3).checksum
+puts Smash.new(:c => 3, :b => 2, :a => 1).checksum
+```
+
+## Memoization
+
+Memoization helpers for thread and object local, thread local,
+and global memoization:
+
+```ruby
+require 'bogo'
+
+class Memo
+  include Bogo::Memoization
+
+  def object_value(provided_value)
+    memoize(:value){ provided_value }
+  end
+
+  def thread_value(provided_value)
+    memoize(:value, true){ provided_value }
+  end
+
+  def global_value(provided_value)
+    memoize(:value, :global){ provided_value }
+  end
+end
+
+obj1 = Memo.new
+obj2 = Memo.new
+
+obj1.object_value('ohai')
+obj1.thread_value('obai')
+obj1.global_value('ohey')
+
+puts '--- obj1 start'
+puts obj1.object_value('fubar')
+puts obj1.thread_value('fubar')
+puts obj1.global_value('fubar')
+puts '--- obj1 end'
+puts '--- obj2 start'
+puts obj2.object_value('fubar')
+puts obj2.thread_value('fubar')
+puts obj2.global_value('fubar')
+puts '--- obj2 end'
+
+## Lazy
+
+Easily define attributes within a class. Provides
+type checking, coercion, and callback integration
+for dependencies and missing values.
+
+```ruby
+require 'bogo'
+
+class MyData
+  include Bogo::Lazy
+
+  attribute :name, String, :default => 'MyData'
+  attribute :data_id, [String, Numeric]
+  attribute :count, Float, :coerce => lambda{|v| v.to_f}
+  attribute :remote_id, Integer, :depends => :remote_loader
+  attribute :stuff, String
+
+  on_missing :load_things
+
+  def remote_loader
+    data[:remote_id] = 42
+  end
+
+  def load_things
+    data[:stuff] = 'ALL THE THINGS'
+  end
+end
+
+data = MyData.new
+
+puts data.name
+data.name = 'New name!'
+puts data.name
+data.data_id = 1
+puts data.data_id
+data.data_id = 'one'
+puts data.data_id
+begin
+  data.data_id = :one
+rescue TypeError => e
+  puts "#{e.class}: #{e}"
+end
+data.count = '1'
+p data.count
+puts data.remote_id
+puts data.stuff
+p data.dirty?(:name)
+p data.data_id
+p data.data
+p data.dirty
+p data.attributes
+p data.dirty?
+data.valid_state
+p data.dirty?
+p data.data
+```
 
 ## Info
 * Repository: https://github.com/spox/bogo

data/bogo.gemspec

@@ -11,5 +11,6 @@ Gem::Specification.new do |s|
   s.require_path = 'lib'
   s.license = 'Apache 2.0'
   s.add_dependency 'hashie'
+  s.add_dependency 'multi_json'
   s.files = Dir['lib/**/*'] + %w(bogo.gemspec README.md CHANGELOG.md CONTRIBUTING.md LICENSE)
 end

data/lib/bogo.rb

@@ -7,4 +7,5 @@ module Bogo
   autoload :Smash, 'bogo/smash'
 end
 
-autoload :Smash, 'bogo/smash'
+# Always load smash
+require 'bogo/smash'

data/lib/bogo/lazy.rb

@@ -1,4 +1,5 @@
 require 'bogo'
+require 'multi_json'
 require 'digest/sha2'
 
 module Bogo
@@ -12,6 +13,11 @@ module Bogo
       def data
         unless(@data)
           @data = Smash.new
+          self.class.attributes.each do |key, value|
+            if(value.has_key?('default'))
+              @data[key] = value['default']
+            end
+          end
         end
         @data
       end

data/lib/bogo/memoization.rb

@@ -4,6 +4,38 @@ module Bogo
   # Memoization helpers
   module Memoization
 
+    class << self
+
+      # Clean up isolated memoizations
+      #
+      # @param object_id [Object]
+      # @return [Proc]
+      def cleanup(object_id)
+        proc do
+          Thread.current[:bogo_memoization].delete_if do |k,v|
+            k.to_s.start_with?(object_id.to_s)
+          end
+        end
+      end
+
+      # Clear thread memoizations
+      #
+      # @return [nil]
+      def clear_current!
+        Thread.current[:bogo_memoization] = nil
+      end
+
+      # Clear global memoizations
+      #
+      # @return [nil]
+      def clear_global!
+        Thread.exclusive do
+          $bogo_memoization = Smash.new
+        end
+      end
+
+    end
+
     # Memoize data
     #
     # @param key [String, Symbol] identifier for data
@@ -15,14 +47,29 @@ module Bogo
       unless(direct)
         key = "#{self.object_id}_#{key}"
       end
-      unless(_memo.has_key?(key))
-        _memo[key] = yield
+      if(direct == :global)
+        Thread.exclusive do
+          $bogo_memoization ||= Smash.new
+          unless($bogo_memoization.has_key?(key))
+            $bogo_memoization[key] = yield
+          end
+          $bogo_memoization[key]
+        end
+      else
+        unless(_memo.has_key?(key))
+          _memo[key] = yield
+        end
+        _memo[key]
       end
-      _memo[key]
     end
 
+    # @return [Smash] memoization hash for current thread
     def _memo
-      Thread.current[:bogo_memoization] ||= Smash.new
+      unless(Thread.current[:bogo_memoization])
+        Thread.current[:bogo_memoization] = Smash.new
+        ObjectSpace.define_finalizer(self, Bogo::Memoization.cleanup(self.object_id))
+      end
+      Thread.current[:bogo_memoization]
     end
 
     # Remove memoized value
@@ -34,7 +81,14 @@ module Bogo
       unless(direct)
         key = "#{self.object_id}_#{key}"
       end
-      _memo.delete(key)
+      if(direct == :global)
+        Thread.exclusive do
+          $bogo_memoization ||= Smash.new
+          $bogo_memoization.delete(key)
+        end
+      else
+        _memo.delete(key)
+      end
     end
 
     # Remove all memoized values

data/lib/bogo/version.rb

@@ -1,4 +1,4 @@
 module Bogo
   # Current library version
-  VERSION = Gem::Version.new('0.1.0')
+  VERSION = Gem::Version.new('0.1.2')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bogo
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Chris Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-29 00:00:00.000000000 Z
+date: 2014-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Helper libraries
 email: code@chrisroberts.org
 executables: []