waistband 0.1.1 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0bb1048847e31a803f414112221ee12f51ec7df9
+  data.tar.gz: 2ba18a9f7eb6ab073ce1a2c0f20b06fa4006b90f
+SHA512:
+  metadata.gz: e6e394da1f1941fcba5487e59debe69f063c4eb7893e33fb9bbfcf1c8fdc9017baceeaba2ada6b2ecdfb04fb2ffa943905439aea31855c4f7a4b7a2bd06094be
+  data.tar.gz: f45002b13606503854402badae133138e67cc351f6eae142b0e49c130023e71253bc0bed174ea65e79a30c8d97eb4bb8d0fd4070d957eec1131d1c5c0ad68ab7

data/README.md

@@ -70,7 +70,7 @@ development:
 ## List of config settings:
 
 * `name`: name of the index.  You can (and probably should) have a different name for the index for your test environment.
-* `stringify`: determines wether whatever is stored into the index is going to be converted to a string before storage.  Usually false unless you need it to be true for specific cases, like if for some `key => value` pairs the value is of different types some times.  If you do decide to stringify your values for an index, please read the **Stringify All** section of the docs further down.
+* `stringify`: determines wether whatever is stored into the index is going to be converted to a string before storage.  Usually false unless you need it to be true for specific cases, like if for some `key => value` pairs the value is of different types some times.
 * `settings`: settings for the Elastic Search index.  Refer to the ["admin indices update settings"](http://www.elasticsearch.org/guide/reference/api/admin-indices-update-settings/) document for more info.
 * `mappings`: the index mappings.  More often than not you'll want to include all of the document attribute, so you'll do something like in the example above.  For more info, refer to the [mapping reference]("http://www.elasticsearch.org/guide/reference/mapping/").
 
@@ -163,10 +163,6 @@ query.results
 
 For paginating the results, you can use the `#paginated_results` method, which requires the [Kaminari](https://github.com/amatsuda/kaminari), gem.  If you use another gem, you can just override the method, etc.
 
-### Stringify All
-
-For convenience, Waistband provides two mixins useful to stringify Arrays and Hashes recursively in the `Waistband::StringifyAll::Array` and `Waistband::StringifyAll::Hash` modules.  Feel free to include them into your Array or Hash classes as necessary in an initializer if needed.
-
 ### Model
 
 The gem offers a `Waistband::Model` that you can use to store model type data into the Elastic Search index.  You just inherit from the class and define the following class methods:

data/lib/waistband.rb

@@ -2,13 +2,14 @@ require "waistband/version"
 
 module Waistband
   
-  autoload :Configuration,  "waistband/configuration"
-  autoload :StringifyAll,   "waistband/stringify_all"
-  autoload :QueryResult,    "waistband/query_result"
-  autoload :Query,          "waistband/query"
-  autoload :Index,          "waistband/index"
-  autoload :QuickError,     "waistband/quick_error"
-  autoload :Model,          "waistband/model"
+  autoload :Configuration,    "waistband/configuration"
+  autoload :StringifiedArray, "waistband/stringified_array"
+  autoload :StringifiedHash,  "waistband/stringified_hash"
+  autoload :QueryResult,      "waistband/query_result"
+  autoload :Query,            "waistband/query"
+  autoload :Index,            "waistband/index"
+  autoload :QuickError,       "waistband/quick_error"
+  autoload :Model,            "waistband/model"
 
   class << self
 

data/lib/waistband/index.rb

@@ -41,9 +41,22 @@ module Waistband
 
     def store!(key, data)
       # map everything to strings
-      data = data.stringify_all if @stringify && data.respond_to?(:stringify_all)
+      if @stringify
+        original_data = data
 
-      RestClient.put(url_for_key(key), data.to_json)
+        if data.is_a?(Array)
+          data = Waistband::StringifiedArray.new(data)
+        elsif data.is_a?(Hash)
+          data = Waistband::StringifiedHash.new_from(data)
+        end
+
+        data = data.stringify_all if data.respond_to?(:stringify_all)
+      end
+
+      result  = RestClient.put(url_for_key(key), data.to_json)
+      data    = original_data if @stringify
+
+      result
     end
 
     def delete!(key)

data/lib/waistband/stringified_array.rb

@@ -0,0 +1,15 @@
+module Waistband
+  class StringifiedArray < Array
+
+    def stringify_all
+      self.map do |val|
+        if val.respond_to?(:to_s)
+          val.to_s
+        else
+          val
+        end
+      end
+    end
+
+  end
+end

data/lib/waistband/stringified_hash.rb

@@ -0,0 +1,31 @@
+module Waistband
+  class StringifiedHash < Hash
+
+    class << self
+
+      def new_from(original)
+        copy = new
+        original.each do |k, v|
+          copy[k] = v
+        end
+        copy
+      end
+
+    end
+
+    def stringify_all
+      stringified = {}
+
+      each do |key, val|
+        if val.respond_to?(:to_s)
+          stringified[key] = val.to_s
+        else
+          stringified[key] = val
+        end
+      end
+
+      stringified
+    end
+
+  end
+end

data/lib/waistband/version.rb

@@ -1,3 +1,3 @@
 module Waistband
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/spec/lib/index_spec.rb

@@ -2,8 +2,9 @@ require 'spec_helper'
 
 describe Waistband::Index do
 
-  let(:index) { Waistband::Index.new('events') }
-  let(:attrs) { {'ok' => {'yeah' => true}} }
+  let(:index)   { Waistband::Index.new('events') }
+  let(:index2)  { Waistband::Index.new('search') }
+  let(:attrs)   { {'ok' => {'yeah' => true}} }
 
   it "initializes values" do
     index.instance_variable_get('@index_name').should eql 'events_test'
@@ -45,17 +46,23 @@ describe Waistband::Index do
 
   describe "storing" do
 
-    before { index.store!('__test_write', attrs) }
-
     it "stores data" do
-      index.read('__test_write').should eql attrs
+      index.store!('__test_write', {'ok' => 'yeah'})
+      index.read('__test_write').should eql({'ok' => 'yeah'})
+    end
+
+    it "data is stringified" do
+      index.store!('__test_write', attrs)
+      index.read('__test_write').should eql({"ok"=>"{\"yeah\"=>true}"})
     end
 
-    it "data is indirectly accessible" do
-      index.read('__test_write')[:ok][:yeah].should eql true
+    it "data is indirectly accessible when not stringified" do
+      index2.store!('__test_not_string', attrs)
+      index2.read('__test_not_string')[:ok][:yeah].should eql true
     end
 
     it "deletes data" do
+      index.store!('__test_write', attrs)
       index.delete!('__test_write')
       index.read('__test_write').should be_nil
     end
@@ -65,8 +72,6 @@ describe Waistband::Index do
     end
 
     it "doesn't mix data between two indexes" do
-      index2 = Waistband::Index.new('search')
-
       index.store!('__test_write',  {'data' => 'index_1'})
       index2.store!('__test_write', {'data' => 'index_2'})
 

data/spec/lib/model_spec.rb

@@ -4,7 +4,7 @@ describe Waistband::Model do
 
   class Log < Waistband::Model
 
-    with_index  :events
+    with_index  :search
     columns     :log, :user_id, :content
     stringify   :content
     defaults    user_id: 999

data/spec/lib/stringified_array_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Waistband::StringifiedArray do
+
+  it "stringifies everything in an array" do
+    Waistband::StringifiedArray.new([1, 2, 3]).stringify_all.should eql %w(1 2 3)
+  end
+
+end

data/spec/lib/stringified_hash_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Waistband::StringifiedHash do
+
+  let(:hash) { Waistband::StringifiedHash.new }
+
+  it "stringifies everything in a hash" do
+    hash['name'] = :peter
+    hash['description'] = {'full' => 'ok'}
+    hash.stringify_all.should eql({'name' => 'peter', 'description' => "{\"full\"=>\"ok\"}"})
+  end
+
+  it "recurses" do
+    hash['name'] = :peter
+    hash['description'] = [1, 2, 3]
+    hash.stringify_all.should eql({'name' => 'peter', 'description' => "[1, 2, 3]"})
+  end
+
+  it "creates a stringified array from a hash" do
+    copy = Waistband::StringifiedHash.new_from({'name' => 'peter', 'description' => [1, 2, 3]})
+    copy.should be_a Waistband::StringifiedHash
+    copy['name'].should eql 'peter'
+    copy['description'].should eql [1, 2, 3]
+    copy.stringify_all.should eql({'name' => 'peter', 'description' => "[1, 2, 3]"})
+  end
+
+end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: waistband
 version: !ruby/object:Gem::Version
-  version: 0.1.1
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - David Jairala
@@ -14,23 +13,20 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -78,17 +69,15 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Ruby interface to Elastic Search
@@ -113,7 +102,8 @@ files:
 - lib/waistband/query.rb
 - lib/waistband/query_result.rb
 - lib/waistband/quick_error.rb
-- lib/waistband/stringify_all.rb
+- lib/waistband/stringified_array.rb
+- lib/waistband/stringified_hash.rb
 - lib/waistband/version.rb
 - spec/config/waistband/waistband.yml
 - spec/config/waistband/waistband_events.yml
@@ -123,34 +113,34 @@ files:
 - spec/lib/model_spec.rb
 - spec/lib/query_result_spec.rb
 - spec/lib/query_spec.rb
-- spec/lib/stringify_all_spec.rb
+- spec/lib/stringified_array_spec.rb
+- spec/lib/stringified_hash_spec.rb
 - spec/spec_helper.rb
 - spec/support/index_helper.rb
 - waistband.gemspec
 homepage: https://github.com/taskrabbit/waistband
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Elastic Search all the things!
 test_files:
 - spec/config/waistband/waistband.yml
@@ -161,6 +151,7 @@ test_files:
 - spec/lib/model_spec.rb
 - spec/lib/query_result_spec.rb
 - spec/lib/query_spec.rb
-- spec/lib/stringify_all_spec.rb
+- spec/lib/stringified_array_spec.rb
+- spec/lib/stringified_hash_spec.rb
 - spec/spec_helper.rb
 - spec/support/index_helper.rb

data/lib/waistband/stringify_all.rb

@@ -1,39 +0,0 @@
-module Waistband
-
-  module StringifyAll
-
-    module Array
-
-      def stringify_all
-        self.map do |val|
-          if val.respond_to?(:to_s)
-            val.to_s
-          else
-            val
-          end
-        end
-      end
-
-    end
-
-    module Hash
-
-      def stringify_all
-        stringified = {}
-
-        each do |key, val|
-          if val.respond_to?(:to_s)
-            stringified[key] = val.to_s
-          else
-            stringified[key] = val
-          end
-        end
-
-        stringified
-      end
-
-    end
-
-  end
-
-end

data/spec/lib/stringify_all_spec.rb

@@ -1,22 +0,0 @@
-require 'spec_helper'
-
-describe Waistband::StringifyAll do
-
-  before do
-    Array.send(:include, Waistband::StringifyAll::Array)
-    Hash.send(:include, Waistband::StringifyAll::Hash)
-  end
-
-  it "stringifies everything in an array" do
-    [1, 2, 3].stringify_all.should eql %w(1 2 3)
-  end
-
-  it "stringifies everything in a hash" do
-    {'name' => :peter, 'description' => {'full' => 'ok'}}.stringify_all.should eql({'name' => 'peter', 'description' => "{\"full\"=>\"ok\"}"})
-  end
-
-  it "recurses" do
-    {'name' => :peter, 'description' => [1, 2, 3]}.stringify_all.should eql({'name' => 'peter', 'description' => "[1, 2, 3]"})
-  end
-
-end