kashmir 0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c5780c967e6ff6ba5b26f80137d30266d1d55554
-  data.tar.gz: e4b5a243cfaa28a516c9637457a34f880612d766
+  metadata.gz: e10560235dc4ce72083facd7ea74c69b3bedb255
+  data.tar.gz: b418df0a0a818e6f00683e5c0115b2c619c0134d
 SHA512:
-  metadata.gz: 88b891a003b3a760036888515d56b6dfbc2bab338103c3f2a146d10dd61b5ed887ab438e40e10b8f786bb3db9e8388114852d952821e3685aea3ef6df6507c9f
-  data.tar.gz: d1ee5652b5359b418efebe856de46738322eb6213575c9a49e0b71753064313cd2c3e62a7e7dab3bfc64920266ad614857e9e92b35bd02075502e1d4e1ad5709
+  metadata.gz: a63bfb22aad18c97ed7a477a35a752fbe82c8d90bb09caf1d9b3651312dae3fe9430e2cc7770423454a98776475279fa12b031406721f2c3dac7461c66e08847
+  data.tar.gz: c4723de817322bea9e4ab0069424a3d8144f3c2ec6bb314ea8c6d62688b143b4483b10bcad8dfe591e36c9f078b19bb636afd10da9c171bf3d6c3d54c37e8708

data/{LICENSE.txt → LICENSE}

@@ -1,4 +1,4 @@
-Copyright (c) 2015 Netto Farah
+Copyright (c) 2015 IFTTT
 
 MIT License
 

data/README.md

@@ -1,18 +1,20 @@
-# Kashmir
+[![Open Source at IFTTT](http://ifttt.github.io/images/open-source-ifttt.svg)](http://ifttt.github.io)
 
-Kashmir is a DSL built to allow developers to describe representations of their ruby objects.
-Kashmir will turn these ruby objects into `Hash`es that represent the dependency tree you just described.
+![Kashmir](https://raw.githubusercontent.com/IFTTT/kashmir/images/images/kashmirbanner.jpg?token=AAIf5wn0aFvxx1oNOO6GVw7SO4vENFW4ks5VuSaLwA%3D%3D "Kashmir")
 
-`Kashmir::ActiveRecord` will also optimize and try to balance `ActiveRecord` queries, so your application hits the database as little as possible.
+Kashmir is a DSL built to allow developers to describe representations of Ruby objects.
+Kashmir will turn these Ruby objects into hashes that represent the dependency tree you just described.
 
-`Kashmir::Caching` builds a dependency tree for complex object representations and caches each level of this tree separately. Kashmir will do so by creating cache views of each one of these layers, but also caching a complete tree.
-The caching engine is smart enough to fill out holes in the cache tree with fresh data from your database or another sort of data store.
+`Kashmir::ActiveRecord` will also optimize and try to balance `ActiveRecord` queries so your application hits the database as little as possible.
+
+`Kashmir::Caching` builds a dependency tree for complex object representations and caches each level of this tree separately. Kashmir will do so by creating cache views of each level as well as caching a complete tree.
+The caching engine is smart enough to fill holes in the cache tree with fresh data from your data store.
 
 Combine `Kashmir::Caching` + `Kashmir::ActiveRecord` for extra awesomeness.
 
 ### Example:
 
-For example, a `Person` with a `name` and `age`:
+For example, a `Person` with `name` and `age` attributes:
 ```ruby
   class Person
     include Kashmir
@@ -34,18 +36,21 @@ could be represented as:
 ```
 
 Representing an object is as simple as:
-1. add `include Kashmir` to the target class
-2. whitelist all the fields you may want in a representation.
+
+1. Add `include Kashmir` to the target class.
+2. Whitelist all the fields you want to include in a representation.
+
 ```ruby
-# add all the fields, methods you want to be visible to Kashmir
+# Add fields and methods you want to be visible to Kashmir
 representations do
-  rep(:name) # this exposes the property name to Kashmir
+  rep(:name)
   rep(:age)
 end
 ```
+
 3. Instantiate an object and `#represent` it.
 ```ruby
-# you can pass in an array with all the fields you want to be represented
+# Pass in an array with all the fields you want included
 Person.new('Netto Farah', 26).represent([:name, :age]) 
  => {:name=>"Netto Farah", :age=>"26"} 
 ```
@@ -65,11 +70,11 @@ And then execute:
 ## Usage
 Kashmir is better described with examples.
 
-### Basic representations
+### Basic Representations
 
-#### Describing an object
+#### Describing an Object
 Only whitelisted fields can be represented by Kashmir.
-This is done so secret fields don't get exposed to clients, such as passwords and salts.
+This is done so sensitive fields (like passwords) cannot be accidentally exposed to clients.
 
 ``` ruby
 class Recipe < OpenStruct
@@ -84,17 +89,17 @@ end
 
 Instantiate a `Recipe`:
 ```ruby
-recipe = Recipe.new(title: 'Beef stew', preparation_time: 60)
+recipe = Recipe.new(title: 'Beef Stew', preparation_time: 60)
 ```
 
-Kashmir automatically adds a `#represent` method to every instance of `Recipe` now.
-`#represent` will take an `Array` with all the fields you want as part of your representation.
+Kashmir automatically adds a `#represent` method to every instance of `Recipe`.
+`#represent` takes an `Array` with all the fields you want as part of your representation.
 
 ```ruby
 recipe.represent([:title, :preparation_time])
-=> { title: 'Beef stew', preparation_time: 60 }
+=> { title: 'Beef Stew', preparation_time: 60 }
 ```
-#### Calculated fields
+#### Calculated Fields
 You can represent any instance variable or method (basically anything that returns `true` for `respond_to?`).
 ``` ruby
 class Recipe < OpenStruct
@@ -112,11 +117,11 @@ end
 ```
 
 ```ruby
-Recipe.new(title: 'Beef stew', steps: ['chop', 'cook']).represent([:title, :num_steps])
-=> { title: 'Beef stew', num_steps: 2 }
+Recipe.new(title: 'Beef Stew', steps: ['chop', 'cook']).represent([:title, :num_steps])
+=> { title: 'Beef Stew', num_steps: 2 }
 ```
 
-### Nested representations
+### Nested Representations
 You can nest Kashmir objects to represent complex relationships between your objects.
 ```ruby
 class Recipe < OpenStruct
@@ -137,8 +142,7 @@ class Chef < OpenStruct
 end
 ```
 
-Nested representations can be described as hashes inside your array of fields.
-You can then pass in another array with all the properties you want to present in the nested object.
+When you create a representation, nest hashes to create nested representations.
 ```ruby
 netto = Chef.new(name: 'Netto Farah')
 beef_stew = Recipe.new(title: 'Beef Stew', chef: netto)
@@ -153,8 +157,8 @@ beef_stew.represent([:title, { :chef => [ :name ] }])
 ```
 Not happy with this syntax? Check out `Kashmir::DSL` or `Kashmir::InlineDSL` for prettier code.
 
-#### Base representations
-Tired of repeating the same fields over and over?
+#### Base Representations
+Are you tired of repeating the same fields over and over?
 You can create a base representation of your objects, so Kashmir returns basic fields automatically.
 ```ruby
 class Recipe
@@ -207,7 +211,7 @@ end
 ```
 
 ```ruby
-bbq_joint = Restaurant.new(name: "Netto's BBQ Joint", rating: '5 stars')
+bbq_joint = Restaurant.new(name: "Netto's BBQ Joint", rating: '5 Stars')
 netto = Chef.new(name: 'Netto', restaurant: bbq_joint)
 brisket = Recipe.new(title: 'BBQ Brisket', chef: netto)
 
@@ -223,7 +227,7 @@ brisket.represent([
     name: 'Netto',
     restaurant: {
       name: "Netto's BBQ Joint",
-      rating: '5 stars'
+      rating: '5 Stars'
     }
   }
 }
@@ -310,7 +314,7 @@ brisket.represent(RecipePresenter)
 
 =>  { title: 'BBQ Brisket', num_steps: 2 }
 ```
-#### Embed Representers
+#### Embedded Representers
 It is also possible to define nested representers with `embed(:property_name, RepresenterClass)`.
 
 ```ruby
@@ -388,7 +392,7 @@ end
 => { title: 'BBQ Brisket', num_steps: 2 }
 ```
 
-#### Nested inline representations
+#### Nested Inline Representations
 You can nest inline representations using `inline(:field, &block)` the same way we did with `Kashmir::Dsl`.
 
 ```ruby
@@ -512,7 +516,7 @@ For more examples, check out: https://github.com/IFTTT/kashmir/blob/master/test/
 Caching is the best feature in Kashmir.
 The `Kashmir::Caching` module will cache every level of the dependency tree Kashmir generates when representing an object.
 
-![Dependency Tree](http://imageshack.com/a/img661/6152/LAGBwO.png "Dependency Tree")
+![Dependency Tree](https://raw.githubusercontent.com/IFTTT/kashmir/images/images/kashmir.png?token=AAIf57rtAVfFPENYmWfBJ9nhZOmbFs1qks5VuVFOwA%3D%3D "Dependency Tree")
 
 As you can see in the image above, Kashmir will build a dependency tree of the representation.
 If you have Caching on, Kashmir will:
@@ -527,7 +531,7 @@ Kashmir will also be able to fill in blanks in the dependency tree and fetch mis
 Caching is turned off by default, but you can use one of the two available implementations.
 
 - [In Memory Caching] https://github.com/IFTTT/kashmir/blob/master/lib/kashmir/plugins/memory_caching.rb
-- [Memcached] https://github.com/IFTTT/kashmir/blob/master/lib/kashmir/plugins/memcached_caching.rb (Currently used on ifttt.com).
+- [Memcached] https://github.com/IFTTT/kashmir/blob/master/lib/kashmir/plugins/memcached_caching.rb
 
 You can also build your own custom caching engine by following the `NullCaching` protocol available at:
 https://github.com/IFTTT/kashmir/blob/master/lib/kashmir/plugins/null_caching.rb
@@ -542,6 +546,8 @@ Kashmir.init(
 
 ##### With Memcached
 ```ruby
+require 'kashmir/plugins/memcached_caching'
+
 client = Dalli::Client.new(url, namespace: 'kashmir', compress: true)
 default_ttl = 5.minutes
 

data/kashmir.gemspec

@@ -21,8 +21,6 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "colorize", "~> 0.7"
-
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
@@ -30,6 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "mocha", "~> 1.1"
   spec.add_development_dependency "sqlite3", "1.3.10"
 
-  spec.add_development_dependency "dalli", "~> 2.7"
-  spec.add_development_dependency "activerecord", "3.2.8"
+  spec.add_development_dependency "activerecord", "~> 4.2"
 end

data/lib/kashmir.rb

@@ -5,6 +5,7 @@ require "kashmir/inline_dsl"
 require "kashmir/plugins/ar"
 require "kashmir/caching"
 require "kashmir/representable"
+require 'logger'
 
 module Kashmir
 

data/lib/kashmir/caching.rb

@@ -1,39 +1,37 @@
 require 'kashmir/plugins/memory_caching'
 require 'kashmir/plugins/null_caching'
-require 'kashmir/plugins/memcached_caching'
-require 'colorize'
 
 module Kashmir
   module Caching
 
     def from_cache(representation_definition, object)
-      log("#{"read".blue}: #{log_key(object, representation_definition)}", :debug)
+      log("read: #{log_key(object, representation_definition)}", :debug)
 
       cached_representation = Kashmir.caching.from_cache(representation_definition, object)
 
       if cached_representation
-        log("#{"hit".green}: #{log_key(object, representation_definition)}")
+        log("hit: #{log_key(object, representation_definition)}")
       else
-        log("#{"miss".red}: #{log_key(object, representation_definition)}")
+        log("miss: #{log_key(object, representation_definition)}")
       end
 
       cached_representation
     end
 
     def bulk_from_cache(representation_definition, objects)
-      class_name = objects.size > 0 ? objects.first.class.to_s : ''
-      log("#{"read_multi".blue}: [#{objects.size}]#{class_name} : #{representation_definition}", :debug)
+      class_name = objects.length > 0 ? objects.first.class.to_s : ''
+      log("read_multi: [#{objects.length}]#{class_name} : #{representation_definition}", :debug)
       Kashmir.caching.bulk_from_cache(representation_definition, objects)
     end
 
     def store_presenter(representation_definition, representation, object, ttl)
-      log("#{"write".blue} TTL: #{ttl}: #{log_key(object, representation_definition)}", :debug)
+      log("write TTL: #{ttl}: #{log_key(object, representation_definition)}", :debug)
       Kashmir.caching.store_presenter(representation_definition, representation, object, ttl)
     end
 
     def bulk_write(representation_definition, representations, objects, ttl)
-      class_name = objects.size > 0 ? objects.first.class.to_s : ''
-      log("#{"write_multi".blue}: TTL: #{ttl}: [#{objects.size}]#{class_name} : #{representation_definition}", :debug)
+      class_name = objects.length > 0 ? objects.first.class.to_s : ''
+      log("write_multi: TTL: #{ttl}: [#{objects.length}]#{class_name} : #{representation_definition}", :debug)
       Kashmir.caching.bulk_write(representation_definition, representations, objects, ttl)
     end
 
@@ -42,7 +40,7 @@ module Kashmir
     end
 
     def log(message, level=:info)
-      Kashmir.logger.send(level, ("\n#{"Kashmir::Caching".magenta} #{message}\n"))
+      Kashmir.logger.send(level, ("\nKashmir::Caching #{message}\n"))
     end
 
     module_function :from_cache, :bulk_from_cache, :bulk_write, :store_presenter, :log_key, :log

data/lib/kashmir/patches/active_record.rb

@@ -1,8 +1,8 @@
 # We have to reopen Preloader to allow for it
 # to accept any random attribute name as a preloadable association.
 #
-# This allows us to send any abirtrary Hash to Preloader.
-# Not only keys that we know are ActiveRecord relations in advance.
+# This allows us to send any arbitrary Hash to Preloader, without
+# requiring it to be an ActiveRecord relation in advance.
 #
 
 module ArV4Patch
@@ -26,6 +26,8 @@ module ArV4Patch
       klasses = h[assoc.reflection] ||= {}
       (klasses[assoc.klass] ||= []) << record
     end
+
+    h.delete(nil)
     h
   end
 end

data/lib/kashmir/plugins/ar_relation.rb

@@ -12,7 +12,11 @@ module Kashmir
       end
 
       if to_load.any?
-        ActiveRecord::Associations::Preloader.new(to_load, representation_definition).run
+        if ActiveRecord::VERSION::STRING >= "4.0.2"
+          ActiveRecord::Associations::Preloader.new.preload(to_load, representation_definition)
+        else
+          ActiveRecord::Associations::Preloader.new(to_load, representation_definition).run
+        end
       end
 
       to_load_representations = to_load.map do |subject|

data/lib/kashmir/version.rb

@@ -1,3 +1,3 @@
 module Kashmir
-  VERSION = "0.1"
+  VERSION = "0.1.1"
 end

data/test/caching_test.rb

@@ -12,6 +12,12 @@ describe 'Caching' do
     @restaurant = AR::Restaurant.find_by_name('Chef Tom Belly Burgers')
   end
 
+  after(:all) do
+    Kashmir.init(
+      cache_client: Kashmir::Caching::Null.new
+    )
+  end
+
   before(:each) do
     Kashmir.caching.flush!
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kashmir
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: 0.1.1
 platform: ruby
 authors:
 - IFTTT
@@ -9,22 +9,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-20 00:00:00.000000000 Z
+date: 2015-07-23 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: colorize
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -110,33 +96,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.3.10
 - !ruby/object:Gem::Dependency
-  name: dalli
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '4.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 3.2.8
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 3.2.8
+        version: '4.2'
 description: "\n    Kashmir helps you easily define decorators/representers/presenters
   for ruby objects.\n    Optionally, Kashmir will also cache these views for faster
   lookups.\n  "
@@ -148,8 +120,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
-- Gemfile.lock
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
 - kashmir.gemspec

data/Gemfile.lock

@@ -1,49 +0,0 @@
-PATH
-  remote: .
-  specs:
-    kashmir (0.0.1)
-      colorize (~> 0.7)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activemodel (3.2.22)
-      activesupport (= 3.2.22)
-      builder (~> 3.0.0)
-    activerecord (3.2.22)
-      activemodel (= 3.2.22)
-      activesupport (= 3.2.22)
-      arel (~> 3.0.2)
-      tzinfo (~> 0.3.29)
-    activesupport (3.2.22)
-      i18n (~> 0.6, >= 0.6.4)
-      multi_json (~> 1.0)
-    arel (3.0.3)
-    builder (3.0.4)
-    colorize (0.7.7)
-    dalli (2.7.4)
-    i18n (0.7.0)
-    metaclass (0.0.4)
-    minitest (5.5.1)
-    minitest-around (0.3.2)
-      minitest (~> 5.0)
-    mocha (1.1.0)
-      metaclass (~> 0.0.1)
-    multi_json (1.11.1)
-    rake (10.4.2)
-    sqlite3 (1.3.10)
-    tzinfo (0.3.44)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activerecord (~> 3.2.8)
-  bundler (~> 1.7)
-  dalli (~> 2.7)
-  kashmir!
-  minitest (~> 5.0)
-  minitest-around (~> 0.3)
-  mocha (~> 1.1.0)
-  rake (~> 10.0)
-  sqlite3 (= 1.3.10)