squares 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5881a376cfce79ade243a19dfa8f3a9b112d46e6
-  data.tar.gz: 8530ebccc40ed950e0b1298d524d6e57da969149
+  metadata.gz: 61bb7be298dbe905a38099d2a09dca1556937426
+  data.tar.gz: bcab46fab1514b464f6f6dce30e5f42dfcc16e1c
 SHA512:
-  metadata.gz: a16c5788667935c396834e0bac628ffee25259472e2a62025d19b38e6838bdfc0e7c047892ecb3e2a90a94f339d66b99dc18c4aa45dce6297b0e4226f1d43600
-  data.tar.gz: a02e43ca8c0141b600c4a2c3840b5ce3d0960b0797226385d4b30f2e7c76d17865436021151bc8aefc53ed4b1a727523be02be857c3d1596ae6a327b4efa7103
+  metadata.gz: efb185b77ff2174e2f8d2823812e071cc48889120799dfe3466f01b81949528701f3aa35ffc839dd0a0b209cd94f0fab85d7cea61b5f612f99f075b07c735627
+  data.tar.gz: 680d476be0448c0f42ec6d54e390af3801e7b04a20ac94c905c2209d1801632bbada3e1180b7f05e0e23498201ce5d2a7320cb48363a733ce0e73fb1c7c23b2d

data/Guardfile

@@ -0,0 +1,83 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard :bundler do
+  require 'guard/bundler'
+  require 'guard/bundler/verify'
+  helper = Guard::Bundler::Verify.new
+
+  files = ['Gemfile']
+  files += Dir['*.gemspec'] if files.any? { |f| helper.uses_gemspec?(f) }
+
+  # Assume files are symlinked from somewhere
+  files.each { |file| watch(helper.real_path(file)) }
+end
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(%r{^spec/fixtures/.*\.rb$}) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.("routing/#{m[1]}_routing"),
+      rspec.spec.("controllers/#{m[1]}_controller"),
+      rspec.spec.("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/README.md

@@ -47,10 +47,17 @@ You can also provide a default value if you switch to the `property` variant:
 
 ```ruby
 class Person < Squares::Base
-  property :eye_color, default: 'brown'
+  property :irish?, default: false
+  property :eye_color, default: lambda { |person|
+    person.irish? ? 'green' : 'brown'
+  }
 end
 ```
 
+Note that defaults which use callbacks (anything that responds to #call) are
+always applied _after_ defaults which don't use callbacks.  Reverse the order
+of the above two properties, and their defaults would still work.
+
 ### Bootstrapping
 
 _A funny word for "setup & configure".  Bootstrapping.  Bootstrapping.  See?  Funny._
@@ -118,10 +125,25 @@ When we retrieve an object, it returns an instance of that model:
 
 ```ruby
 wallcrawler = Person['spiderman']
-wallcrawler = Person.find 'spiderman' #=> same, shmame.
-wallcrawler.id                        #=> 'spiderman'
-wallcrawler.real_name                 #=> 'Peter Parker'
-wallcrawler.class                     #=> Person
+wallcrawler = Person.find 'spiderman'      #=> same, shmame.
+wallcrawler.class                          #=> Person
+wallcrawler.id                             #=> 'spiderman'
+```
+
+And then, of course, you can
+
+```ruby
+wallcrawler.real_name                      #=> 'Peter Parker'
+wallcrawler[:real_name]                    #=> 'Peter Parker'
+wallcrawler.real_name = 'Petah Pahkah'     #=> Boston's own
+wallcrawler[:real_name] = 'Peshmerga Pete' #=> What is this, even?
+
+wallcrawler.changed?                       #=> true
+wallcrawler.save                           #=> now it's official
+
+wallcrawler.update_properties(             #=> also aliased as
+  real_name: 'Peter Parker'                #   #update_attributes
+)
 ```
 
 Of course, for some types of storage, the model object has to be serialized and
@@ -129,7 +151,7 @@ de-serialized when it's stored and retrieved.  Squares uses `Marshal.dump` and
 `Marshal.restore` to do that.  This means that custom marshalling can be added
 to your models (see [documentation on ruby Marshal][marshal]).
 
-### Even More Fun
+### _Where_-able Computing
 
 You can use the ActiveRecord-esque `.where` method with a block to retrieve records
 for which the block returns true:
@@ -138,13 +160,51 @@ for which the block returns true:
 Person.where { |p| p.left_handed == true } #=> all the lefties
 ```
 
-The `.where` method is actually just an alias of `.select`...which means, yeah!
-Squares are enumerable, yay!
+In this mode, `.where` is essentially just like `.select`...which, oh yeah!
+Squares are enumerable! Yay!
 
 ```ruby
 Person.map(&:name) #=> an array containing all the names
 ```
 
+But you can also pass a hash to `.where` and it will do the expected thing:
+
+```ruby
+Person.where( country: 'Latvaria' )  #=> Dr. Doom, I presume?
+```
+
+And if you give `.where` a series of symbol arguments, it will consider them as
+properties, and check the truthyness of each:
+
+```ruby
+Person.where( :flying?, :secret_lair )  #=> Superman!
+```
+
+### Square Hooks
+
+You can hang a callable (such as a Proc, a Lambda or an instance of class Batman
+which implements `#call`) on any of Squares' polished, hand-crafted hooks:
+
+```ruby
+class Hero
+  after_initialize do
+    tweet "In a world..."
+  end
+end
+```
+
+Squares supports the following hooks:
+
+* after_initialize
+* before/after_create
+* after_find (e.g. after `.find` and also `.[]`)
+* before/after_save
+* before_destroy (`#delete` does not trigger this callback)
+
+There are two important things to remember about Squares' hooks: 1) while a hooked
+callback is in progress, no other hooks will be triggered (i.e. hooks can't fire
+hooks), and 2) never feed Square Hooks after midnight.
+
 ### What It Doesn't Do
 
 Much like Wolverine, Squares doesn't do relationships.  You'll have to
@@ -195,6 +255,19 @@ But hey, who cares, as long as yak hair is truthy?
 
 [marshal]:http://www.ruby-doc.org/core-2.1.5/Marshal.html
 
+## What's New in 0.3.0
+
+* property defaults can use a callback
+* implemented `#[]` on instances (to access properties)
+* `#update_properties` (i.e. `#update_attributes`)
+* square hooks
+* `#changed?`
+* `.where` accepts a hash, and/or series of properties
+
+You can read in more detail on the [0.3.0 milestone][milestone]
+
+[milestone]:https://github.com/joelhelbling/squares/issues?q=milestone%3A0.3.0+sort%3Acreated-asc
+
 ## Contributing
 
 1. Fork it ( https://github.com/joelhelbling/squares/fork )

data/Rakefile

@@ -5,3 +5,12 @@ RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
 
+desc "a console for playing with Squares"
+task :play do
+  require './lib/squares'
+  Dir['spec/fixtures/**/*.rb'].each do |fixture|
+    require File.expand_path(fixture)
+  end
+  require 'pry'
+  binding.pry
+end

data/lib/squares.rb

@@ -1,5 +1,6 @@
 require 'squares/version'
 require 'squares/base'
+require 'json'
 
 module Squares
   class << self

data/lib/squares/base.rb

@@ -3,14 +3,14 @@ module Squares
     attr_accessor :id
 
     def initialize *args
-      apply *args
+      build_instance *args
       trigger :after_initialize
     end
 
     def save
       trigger :before_save
       @_changed = false
-      store[@id] = Marshal.dump self.dup
+      store[@id] = serialize
       trigger :after_save
       nil
     end
@@ -52,13 +52,18 @@ module Squares
       self.class.properties
     end
 
+    def to_json(key_name = :id)
+      to_hash(key_name).to_json
+    end
+
     def to_h(key_name = :id)
-      h = { key_name => id }
-      properties.each do |property|
-        h[property] = self.send(property)
+      { :type => self.class.name, key_name => id }.tap do |h|
+        properties.each do |property|
+          h[property] = self[property]
+        end
       end
-      h
     end
+    alias_method :to_hash, :to_h
 
     def valid_property? property
       self.class.valid_property? property
@@ -68,8 +73,18 @@ module Squares
       self.class.defaults
     end
 
+    def serialize
+      serializers.inject(self.dup) do |memo, serializer|
+        serializer.dump memo
+      end
+    end
+
     private
 
+    def serializers
+      self.class.serializers
+    end
+
     def trigger hook_name
       return if @hook_callback_in_progress
       hooks = self.class.hooks
@@ -88,7 +103,7 @@ module Squares
       end
     end
 
-    def apply *args
+    def build_instance *args
       @id, values = *args
       values_hash = values.to_h
       properties_sorted_by_defaults.each do |property|
@@ -141,9 +156,13 @@ module Squares
     class << self
       include Enumerable
 
+      def serializers
+        [Marshal]
+      end
+
       def [] id
         if item = store[id]
-          Marshal.restore(item).tap do |item|
+          deserialize(item).tap do |item|
             item.instance_eval 'trigger :after_find'
           end
         end
@@ -182,7 +201,7 @@ module Squares
       end
 
       def values
-        store.values.map{ |i| Marshal.restore i }
+        store.values.map{ |i| deserialize i }
       end
 
       def valid_property? property
@@ -273,7 +292,7 @@ module Squares
       end
 
       def models
-        @_models.uniq.sort { |a,b| a.to_s <=> b.to_s }
+        (@_models || []).uniq.sort { |a,b| a.to_s <=> b.to_s }
       end
 
       ### hooks
@@ -328,6 +347,12 @@ module Squares
         @_models << subclass
       end
 
+      def deserialize item
+        serializers.reverse.inject(item) do |memo, serializer|
+          serializer.restore item
+        end
+      end
+
     end
   end
 end

data/lib/squares/version.rb

@@ -1,3 +1,3 @@
 module Squares
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/spec/fixtures/marvel/sidekick.rb

@@ -0,0 +1,5 @@
+module Marvel
+  class Sidekick < Squares::Base
+    property :catch_phrase
+  end
+end

data/spec/fixtures/marvel/super_hero.rb

@@ -0,0 +1,8 @@
+module Marvel
+  class SuperHero < Squares::Base
+    properties :real_name, :special_powers
+    property :caped?, default: false
+  end
+end
+
+

data/spec/fixtures/marvel/villain.rb

@@ -0,0 +1,6 @@
+module Marvel
+  class Villain < Squares::Base
+    properties :vehicle, :lair
+    property :really_evil?, default: true
+  end
+end

data/spec/spec_helper.rb

@@ -3,3 +3,8 @@ $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'pry'
 require 'rspec-given'
 require 'squares'
+
+# load fixtures
+Dir['spec/fixtures/**/*.rb'].each do |fixture|
+  require File.expand_path(fixture)
+end

data/spec/squares/base_spec.rb

@@ -1,20 +1,6 @@
 require 'spec_helper'
 require 'squares/base'
 
-module Marvel
-  class SuperHero < Squares::Base
-    properties :real_name, :special_powers
-    property :caped?, default: false
-  end
-  class Villain < Squares::Base
-    properties :vehicle, :lair
-    property :really_evil?, default: true
-  end
-  class Sidekick < Squares::Base
-    property :catch_phrase
-  end
-end
-
 module Squares
   describe Base do
     Given(:storage)    { {} }
@@ -205,18 +191,48 @@ module Squares
       describe '#to_h' do
         Given(:hero1) { test_class.new id, real_name: name, special_powers: powers }
         context 'default key name' do
-          Given(:expected_hash) { { id: id, real_name: name, special_powers: powers, caped?: false } }
+          Given(:expected_hash) { { type: 'Marvel::SuperHero', id: id, real_name: name, special_powers: powers, caped?: false } }
           When(:result) { hero1.to_h }
           Then { expect(result).to eq(expected_hash) }
         end
 
         context 'custom key name' do
-          Given(:expected_hash) { { hero: id, real_name: name, special_powers: powers, caped?: false } }
+          Given(:expected_hash) { { type: 'Marvel::SuperHero', hero: id, real_name: name, special_powers: powers, caped?: false } }
           When(:result) { hero1.to_h(:hero) }
           Then { expect(result).to eq(expected_hash) }
         end
       end
 
+      describe '#to_json' do
+        Given(:hero1) { test_class.new id, real_name: name, special_powers: powers }
+        context 'default key name' do
+          Given(:expected_json) do
+            {
+              type: 'Marvel::SuperHero',
+              id: id,
+              real_name: name,
+              special_powers: powers,
+              caped?: false
+            }.to_json
+          end
+          When(:result) { hero1.to_json }
+          Then { expect(result).to eq(expected_json) }
+        end
+        context 'custom key name' do
+          Given(:expected_json) do
+            {
+              type: 'Marvel::SuperHero',
+              hero: id,
+              real_name: name,
+              special_powers: powers,
+              caped?: false
+            }.to_json
+          end
+          When(:result) { hero1.to_json(:hero) }
+          Then { expect(result).to eq(expected_json) }
+        end
+      end
+
       describe '#==' do
         Given(:hero1) { test_class.new id, real_name: name, special_powers: powers }
         Given(:hero2) { test_class.new id, real_name: name, special_powers: powers }

data/squares.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["joel@joelhelbling.com"]
   spec.summary       = %q{Lightweight ORM backed by any hash-like storage. [*]}
   spec.description   = %q{[*] Lightweight ORM backed by any hash-like storage: Redis, LevelDB or plain old hashes.}
-  spec.homepage      = "http://github.com/joelhelbling/squares"
+  spec.homepage      = "http://squares.joelhelbling.com"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -23,4 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "rspec-given"
   spec.add_development_dependency "pry"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-bundler"
+  spec.add_development_dependency "guard-rspec"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: squares
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Joel Helbling
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-25 00:00:00.000000000 Z
+date: 2016-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: "[*] Lightweight ORM backed by any hash-like storage: Redis, LevelDB
   or plain old hashes."
 email:
@@ -92,17 +134,21 @@ files:
 - ".rspec"
 - ".travis.yml"
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/squares.rb
 - lib/squares/base.rb
 - lib/squares/version.rb
+- spec/fixtures/marvel/sidekick.rb
+- spec/fixtures/marvel/super_hero.rb
+- spec/fixtures/marvel/villain.rb
 - spec/spec_helper.rb
 - spec/squares/base_spec.rb
 - spec/squares_spec.rb
 - squares.gemspec
-homepage: http://github.com/joelhelbling/squares
+homepage: http://squares.joelhelbling.com
 licenses:
 - MIT
 metadata: {}
@@ -127,6 +173,9 @@ signing_key:
 specification_version: 4
 summary: Lightweight ORM backed by any hash-like storage. [*]
 test_files:
+- spec/fixtures/marvel/sidekick.rb
+- spec/fixtures/marvel/super_hero.rb
+- spec/fixtures/marvel/villain.rb
 - spec/spec_helper.rb
 - spec/squares/base_spec.rb
 - spec/squares_spec.rb