waistband 0.10.0 → 0.11.0

data/README.md

@@ -200,6 +200,13 @@ index.create!
 
 This creates the index `events__2013_01`, which in your application logic you could design to store all event data for Jan 2013.  You'd do the same for Feb, etc., and when you no longer need one of the older ones, you could delete just that sub-index, instead of things getting more complicated.
 
+We've also found quite a bit of usefulness in using index versioning, so you can add/remove fields to your object without much worry.  Waistband accomodates this pattern as follows:
+
+```ruby
+index = Waistband::Index.new('events', version: 1)
+index.create!
+```
+
 ### Aliasing
 
 Part of subbing is gonna be creating the correct aliases that group up your sub-indexes.
@@ -211,7 +218,7 @@ index.alias('my_super_events_alias') # => true
 index.alias_exists?('my_super_events_alias') # => true
 ```
 
-The `alias` methods receives a param to define the alias name.
+The `alias` methods receives a param to define the alias name.  The same pattern can be used when using index versions.
 
 ## Contributing
 

data/lib/waistband/index.rb

@@ -12,9 +12,17 @@ module Waistband
       @index_name = index_name
       @stringify = config['stringify']
 
-      # alias subs
-      @subs = [options['subs']] if options['subs'].present?
-      @subs = @subs.flatten     if @subs.is_a?(Array)
+      # subindexes checks
+      if options['version'].present?
+        # version
+        @version  = options['version']
+        @subs     = ['version', @version]
+      elsif options['subs'].present?
+        # subs
+        @subs = [options['subs']] if options['subs'].present?
+        @subs = @subs.flatten     if @subs.is_a?(Array)
+      end
+
     end
 
     def exists?

data/lib/waistband/version.rb

@@ -1,3 +1,3 @@
 module Waistband
-  VERSION = "0.10.0"
+  VERSION = "0.11.0"
 end

data/spec/lib/index_spec.rb

@@ -116,38 +116,73 @@ describe Waistband::Index do
 
   describe 'subindexes' do
 
-    let(:sharded_index) { Waistband::Index.new('events', subs: %w(2013 01)) }
+    describe 'version option' do
 
-    it "permits subbing the index" do
-      expect(sharded_index.send(:config_name)).to eql 'events_test__2013_01'
-    end
+      let(:sharded_index) { Waistband::Index.new('events', version: 1) }
 
-    it "permits sharding into singles" do
-      index = Waistband::Index.new 'events', subs: '2013'
-      expect(index.send(:config_name)).to eql 'events_test__2013'
-    end
+      it 'behaves exactly like a subs specified subindex' do
+        expect(sharded_index.send(:config_name)).to eql 'events_test__version_1'
+        expect(sharded_index.instance_variable_get('@version')).to eql 1
+      end
 
-    it "retains the same options from the parent index config" do
-      config = sharded_index.send(:config)
+      it "retains the same options from the parent index config" do
+        config = sharded_index.send(:config)
 
-      expect(sharded_index.send(:base_config_name)).to eql 'events_test'
-      expect(config['stringify']).to be_true
-      expect(config['settings']).to be_present
-    end
+        expect(sharded_index.send(:base_config_name)).to eql 'events_test'
+        expect(config['stringify']).to be_true
+        expect(config['settings']).to be_present
+      end
 
-    it "creates the sharded index with the same mappings as the parent" do
-      sharded_index.delete!
+      it "creates the sharded index with the same mappings as the parent" do
+        sharded_index.delete
+
+        expect(Waistband::Index.new('events', version: 1).exists?).to be_false
+
+        expect {
+          sharded_index.create!
+        }.to_not raise_error
+
+        expect(Waistband::Index.new('events', version: 1).exists?).to be_true
+      end
 
-      expect {
-        sharded_index.create!
-      }.to_not raise_error
     end
 
-    describe 'no configged index name' do
+    describe 'subs option' do
+
+      let(:sharded_index) { Waistband::Index.new('events', subs: %w(2013 01)) }
+
+      it "permits subbing the index" do
+        expect(sharded_index.send(:config_name)).to eql 'events_test__2013_01'
+      end
+
+      it "permits sharding into singles" do
+        index = Waistband::Index.new 'events', subs: '2013'
+        expect(index.send(:config_name)).to eql 'events_test__2013'
+      end
+
+      it "retains the same options from the parent index config" do
+        config = sharded_index.send(:config)
+
+        expect(sharded_index.send(:base_config_name)).to eql 'events_test'
+        expect(config['stringify']).to be_true
+        expect(config['settings']).to be_present
+      end
+
+      it "creates the sharded index with the same mappings as the parent" do
+        sharded_index.delete
+
+        expect {
+          sharded_index.create!
+        }.to_not raise_error
+      end
+
+      describe 'no configged index name' do
+
+        it "gets a default name that makes sense for the index when not defined" do
+          index = Waistband::Index.new 'events_no_name', subs: %w(2013 01)
+          expect(index.send(:config_name)).to eql 'events_no_name_test__2013_01'
+        end
 
-      it "gets a default name that makes sense for the index when not defined" do
-        index = Waistband::Index.new 'events_no_name', subs: %w(2013 01)
-        expect(index.send(:config_name)).to eql 'events_no_name_test__2013_01'
       end
 
     end

metadata

@@ -1,18 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: waistband
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
+  prerelease: 
 platform: ruby
 authors:
 - David Jairala
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-22 00:00:00.000000000 Z
+date: 2014-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -20,6 +22,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -27,6 +30,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: elasticsearch
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -34,6 +38,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -41,6 +46,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -48,6 +54,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -55,6 +62,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,6 +70,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -69,6 +78,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -76,6 +86,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -120,26 +131,27 @@ files:
 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: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 1.8.25
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Configuration and sensible defaults for ElasticSearch on Ruby
 test_files:
 - spec/config/waistband/waistband.yml

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    Y2E0YjFjZWZiY2JjMzkyM2ZiODBkZjliYzM3OGI2NjE3NzNlOWJjZA==
-  data.tar.gz: !binary |-
-    ZDlmMWI3N2VmMDU2YTg4Yzc4ZmExOWIxOTZhNGEzZmQyZDlhMWEwYg==
-SHA512:
-  metadata.gz: !binary |-
-    Y2U1YzE3Mjg3MzIzZDAyZWUyNzAyNzIwNmU3YmZhZjBkZTZiMzEyNDg5YzQ1
-    YTAyOTI2YTcwZGVmNDNjMjVkMDNhZDA1ZjNiYTU4MTQzZDQxZGJmNGQxMTM2
-    ZTExZmQxZjZjYjE4ODcwNjE4YWY5ODhkNDNlNzIxMDAyYTFmZDI=
-  data.tar.gz: !binary |-
-    MDlmNzY4NzgxYmVlN2M4NDkzNDQzMzJlNjA0ZDA2M2FiNTQ2ZGE0YjE3ZGZk
-    YjljMTdhNTk0YzJjM2M4YmJkZDYzYzAxYWEwNDYzZTZlYmJhZDAzMzIyYzI2
-    NzBhZjNjYzFhNjRiNzg0ZGU2ODEwYjQzYmYzNzc4YTgxYTQ1NDc=