ripplr 0.0.1.alpha → 0.0.2.beta

data/Gemfile

@@ -2,20 +2,12 @@ source :rubygems
 
 gemspec
 
-gem 'rails', '3.2.3'
+gem 'ripple', "~> 0.9.5"
 
-gem 'ripple', :git => 'https://github.com/seancribbs/ripple.git', :ref => 'b6b37087'
-gem 'yajl-ruby'
-gem 'excon'
-
-group :development do
-  gem 'pry'
-end
+gem 'pry', :groups => [:development, :test]
 
 group :test do
-  gem 'pry'
-  gem 'rb-fsevent'
-  gem 'guard-rspec'
-  gem 'rspec-rails'
-  gem 'rspec-given'
+#   gem 'rb-fsevent'
+#   gem 'guard-rspec'
+   gem 'rspec-given'
 end

data/Gemfile.lock

@@ -0,0 +1,54 @@
+PATH
+  remote: .
+  specs:
+    ripplr (0.0.1.alpha)
+      ripple (>= 0.9.5)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.5)
+      activesupport (= 3.0.5)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activesupport (3.0.5)
+    beefcake (0.3.2)
+    builder (2.1.2)
+    coderay (1.0.7)
+    diff-lcs (1.1.3)
+    i18n (0.6.1)
+    method_source (0.8)
+    pry (0.9.10)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.3.1)
+    rake (0.9.2.2)
+    riak-client (0.9.8)
+      beefcake (= 0.3.2)
+      builder (~> 2.1.2)
+      i18n (>= 0.4.0)
+    ripple (0.9.5)
+      activemodel (~> 3.0.0)
+      activesupport (~> 3.0.0)
+      riak-client (~> 0.9.5)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-given (1.6.0)
+      rspec (> 1.2.8)
+    rspec-mocks (2.11.2)
+    slop (3.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry
+  rake
+  ripple (~> 0.9.5)
+  ripplr!
+  rspec-given

data/lib/ripplr/errors/key_not_specified_error.rb

@@ -0,0 +1,9 @@
+require 'ripplr/translation'
+
+class Ripplr::KeyNotSpecifiedError
+  include Ripplr::Translation
+
+  def exception(message=t("key_not_specified"))
+    RuntimeError.new message
+  end
+end

data/lib/ripplr/errors.rb

@@ -0,0 +1 @@
+  require File.join("ripplr", "errors", "key_not_specified_error")

data/lib/ripplr/formatters/riak.rb

@@ -0,0 +1,17 @@
+module Ripplr
+  module Formatters
+    class Riak
+      def self.to_index(queryable_obj)
+        raise Ripplr::KeyNotSpecifiedError.new unless queryable_obj.respond_to?(:key)
+
+        # index_data = { :id => queryable_obj.key }
+
+        # queryable_obj.class.query_fields.each do |field|
+        #   index_data.merge field.indexes_as(queryable_obj)
+        # end
+
+        
+      end
+    end
+  end
+end

data/lib/ripplr/formatters.rb

@@ -0,0 +1 @@
+  require File.join("ripplr", "formatters", "riak")

data/lib/ripplr/i18n.rb

@@ -0,0 +1,5 @@
+require 'active_support/i18n'
+
+Dir.glob(File.expand_path("../locale/*.yml", __FILE__)).each do |locale_file|
+  I18n.load_path << locale_file
+end

data/lib/ripplr/indexers/ripple.rb

@@ -0,0 +1,9 @@
+module Ripplr
+  module Indexers
+    class Ripple
+      def self.index(queryable_obj)
+        ::Ripple.client.index queryable_obj.bucket_name, queryable_obj.indexes_as
+      end
+    end
+  end
+end

data/lib/ripplr/indexers.rb

@@ -0,0 +1 @@
+  require File.join("ripplr", "indexers", "ripple")

data/lib/ripplr/locale/en.yml

@@ -0,0 +1,3 @@
+en:
+  ripplr:
+    key_not_specified: "Cannot index an object that does not specify a key."

data/lib/ripplr/query_field.rb

@@ -0,0 +1,17 @@
+module Ripplr
+  class QueryField
+    def initialize(type, property_name)
+      @type = type
+      @property = property_name
+    end
+
+    def indexes_as(queryable_object)
+      return { index_name(@type, @property) => queryable_object.send(@property) }
+    end
+
+    private
+    def index_name(type, property_name)
+      "#{property_name.to_s}_#{type.to_s}".to_sym
+    end
+  end
+end

data/lib/ripplr/queryable.rb

@@ -0,0 +1,56 @@
+module Ripplr
+  module Queryable
+    def index(indexer=Ripple.client)
+      indexer.index(self)
+    end
+
+    def remove_index(indexer=Ripple.client)
+    end
+
+    def bucket_name
+      self.class.bucket.name
+    end
+
+    def indexes_as
+      index_data = { :id => self.key }
+
+      self.class.query_fields.each do |field|
+        index_data.merge! field.indexes_as(self)
+      end
+      index_data
+    end
+
+    class << self
+      def included(base)
+        base.module_eval do
+          extend ActsAsMethods
+
+
+        end
+      end
+    end
+
+    module ActsAsMethods
+      def query_fields
+        @query_fields ||= Array.new
+        @query_fields
+      end
+
+      def queryable(&block)
+        block.call
+      end
+
+      def time(*names)
+        names.each do |name|
+          query_fields << Ripplr::QueryField.new(:dt, name)
+        end
+      end
+
+      def text(*names)
+        names.each do |name|
+          query_fields << Ripplr::QueryField.new(:text, name)
+        end
+      end
+    end
+  end
+end

data/lib/ripplr/translation.rb

@@ -0,0 +1,17 @@
+require 'ripplr/i18n'
+require 'riak/util/translation'
+
+module Ripplr
+  module Translation
+    include Riak::Util::Translation
+
+    # The scope of i18n keys to search (:ripple).
+    def i18n_scope
+      :ripplr
+    end
+  end
+
+  # A dummy object so translations can be accessed without module
+  # inclusion.
+  Translator = Object.new.tap {|o| o.extend Translation }
+end

data/lib/ripplr/version.rb

@@ -1,3 +1,3 @@
 module Ripplr
-  VERSION = "0.0.1.alpha"
+  VERSION = "0.0.2.beta"
 end

data/lib/ripplr.rb

@@ -0,0 +1,7 @@
+require 'ripplr/queryable'
+require 'ripplr/query_field'
+require 'ripplr/indexers'
+require 'ripplr/formatters'
+require 'yaml'
+require 'ripplr/translation'
+require 'ripplr/errors'

data/ripplr.gemspec

@@ -12,13 +12,9 @@ Gem::Specification.new do |gem|
   gem.authors = ["Matt Snyder"]
 
   # Deps
-  gem.add_development_dependency "rspec", "~>2.11.0"
-  gem.add_development_dependency 'rake'
-  gem.add_dependency "riak-client", "~> 1.0.0"
-  gem.add_dependency "ripple"
-#  gem.add_dependency "activesupport", [">= 3.0.0", "< 3.3.0"]
-#  gem.add_dependency "activemodel", [">= 3.0.0", "< 3.3.0"]
-  gem.add_dependency "tzinfo"
+  gem.add_development_dependency "rspec-given", ">= 1.6.0"
+  gem.add_development_dependency "rake"
+  gem.add_dependency "ripple", ">= 0.9.5"
 
   # Files
   ignores = File.read(".gitignore").split(/\r?\n/).reject{ |f| f =~ /^(#.+|\s*)$/ }.map {|f| Dir[f] }.flatten

data/spec/ripplr/indexers/ripple_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Ripplr::Indexers::Ripple do
+
+  describe "#index" do
+    Given (:model) { mock :bucket_name => 'my_bucket', :indexes_as => 'some json' }
+    Given { Ripple.client.should_receive(:index).with('my_bucket', 'some json').and_return true }
+    Then { Ripplr::Indexers::Ripple.index(model).should be_true }
+  end
+
+end

data/spec/ripplr/query_field_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe Ripplr::QueryField do
+  context "when text field and property is set" do
+    Given (:john) { Person.new :first_name => 'John' }
+    Given (:query_field) { Ripplr::QueryField.new :text, :first_name }
+    When (:result) { query_field.indexes_as john  }
+    Then { result[:first_name_text].should == 'John' }
+  end
+end

data/spec/ripplr/queryable_spec.rb

@@ -0,0 +1,51 @@
+# -*- coding: utf-8 -*-
+require 'spec_helper'
+
+describe Ripplr::Queryable do
+  context "when ripplr::queryable is included" do
+    Given (:a_class) { class AClass; include Ripplr::Queryable; end }
+    Then { a_class.included_modules.should include(Ripplr::Queryable) }
+    Then { a_class.new.should respond_to(:index) }
+    Then { a_class.new.should respond_to(:remove_index) }
+    Then { a_class.new.should respond_to(:bucket_name) }
+  end
+
+  describe "#bucket_name" do
+    Given { Person.bucket.should_receive(:name).and_return "people" }
+    Then { Person.new.bucket_name.should == "people" }
+  end
+
+  describe "#indexing" do
+    Given (:friend) { Person.new }
+    Given (:service) { mock :index => true }
+    Then { friend.index(service).should be_true }
+  end
+
+  describe "#indexes_as" do
+    context "when the object is queryable and has text fields" do
+      Given (:lawnmower) { Lift.new :title => "Lawnmower", :description => "It’s a variation of the classic dumbbell row so it trains the muscles of your back." }
+      Given { lawnmower.stub(:key).and_return "ABCDEF012345" }
+      When (:result) { lawnmower.indexes_as }
+      Then { result.should == {
+          :id => "ABCDEF012345",
+          :title_text => "Lawnmower",
+          :description_text => "It’s a variation of the classic dumbbell row so it trains the muscles of your back."
+        }
+      }
+    end
+
+    context "when the object is queryable and has text and date fields" do
+      Given (:entry) { LogEntry.new :description => "4x8 BB Power Clean @ 135lbs." }
+      Given (:time) { Time.now }
+      Given { entry.stub(:created_at).and_return time }
+      Given { entry.stub(:key).and_return "XYZ1020" }
+      When (:result) { entry.indexes_as }
+      Then { result.should == {
+          :id => "XYZ1020",
+          :description_text => "4x8 BB Power Clean @ 135lbs.",
+          :created_at_dt => time
+        }
+      }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rspec-given'
+require 'ripplr'
+require 'ripple'
+
+require File.join("support", "models")

data/spec/support/models/lift.rb

@@ -0,0 +1,10 @@
+class Lift
+  include Ripple::Document
+  property :title, String
+  property :description, String
+
+  include Ripplr::Queryable
+  queryable do
+    text :title, :description
+  end
+end

data/spec/support/models/log_entry.rb

@@ -0,0 +1,11 @@
+class LogEntry
+  include Ripple::Document
+  property :created_at, Time
+  property :description, String
+
+  include Ripplr::Queryable
+  queryable do
+    text :description
+    time :created_at
+  end
+end

data/spec/support/models/person.rb

@@ -0,0 +1,10 @@
+class Person
+  include Ripple::Document
+  property :first_name, String
+  property :last_name, String
+
+  include Ripplr::Queryable
+  queryable do
+    text :first_name, :last_name
+  end
+end

data/spec/support/models.rb

@@ -0,0 +1,3 @@
+require File.join("support", "models", "person")
+require File.join("support", "models", "lift")
+require File.join("support", "models", "log_entry")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ripplr
 version: !ruby/object:Gem::Version
-  version: 0.0.1.alpha
+  version: 0.0.2.beta
   prerelease: 6
 platform: ruby
 authors:
@@ -9,24 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-05 00:00:00.000000000 Z
+date: 2012-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec-given
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.11.0
+        version: 1.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.11.0
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -43,22 +43,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: riak-client
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: ripple
   requirement: !ruby/object:Gem::Requirement
@@ -66,23 +50,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: tzinfo
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -90,7 +58,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.5
 description: Ripplr provides a lower barrier to entry for developers wishing to migrate
   to Riak. Ripplr focuses on enhancing the use of the Ripple Gem by adding Riak Search
   functionality to your objects.
@@ -101,10 +69,31 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
+- Gemfile.lock
+- lib/ripplr/errors/key_not_specified_error.rb
+- lib/ripplr/errors.rb
+- lib/ripplr/formatters/riak.rb
+- lib/ripplr/formatters.rb
+- lib/ripplr/i18n.rb
+- lib/ripplr/indexers/ripple.rb
+- lib/ripplr/indexers.rb
+- lib/ripplr/locale/en.yml
+- lib/ripplr/query_field.rb
+- lib/ripplr/queryable.rb
+- lib/ripplr/translation.rb
 - lib/ripplr/version.rb
+- lib/ripplr.rb
 - Rakefile
 - README.md
 - ripplr.gemspec
+- spec/ripplr/indexers/ripple_spec.rb
+- spec/ripplr/query_field_spec.rb
+- spec/ripplr/queryable_spec.rb
+- spec/spec_helper.rb
+- spec/support/models/lift.rb
+- spec/support/models/log_entry.rb
+- spec/support/models/person.rb
+- spec/support/models.rb
 - .gitignore
 homepage: https://github.com/validas/Ripplr
 licenses: []
@@ -132,4 +121,12 @@ specification_version: 3
 summary: Ripplr is a library to ease the use of Riak Search from within Rails when
   using Ripple and Riak Client.
 test_files:
+- spec/ripplr/indexers/ripple_spec.rb
+- spec/ripplr/query_field_spec.rb
+- spec/ripplr/queryable_spec.rb
+- spec/spec_helper.rb
+- spec/support/models/lift.rb
+- spec/support/models/log_entry.rb
+- spec/support/models/person.rb
+- spec/support/models.rb
 - .gitignore