fire-model 0.0.2 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f7fd0add86121b4fbf5a68566e37c7263fd06aa5
-  data.tar.gz: c15777871d1c0bf246e586a09ab03b8fb3d2d4c1
+  metadata.gz: e6c2fd8a5b0c94437795c9fb89ba94b2cfcc5b5c
+  data.tar.gz: ad45e8dbfeebfe2a2f526b1776683520db018781
 SHA512:
-  metadata.gz: 94df03e10630d8eca7876f2b321988970e591107ca8e6486cff9c72a310e045a966506d9702361330acc626e0887ef4167edaa2ea010fa246c2a6212c23cd931
-  data.tar.gz: 136759d17f0a80f3d96ab9bae63db8d1614ce6c95dfadf411200d5b12b4c0a7aaead321045e00d86f96bb0fa89b492b85f4c054b8606d7b5fa8e4ed8ed0de286
+  metadata.gz: d20eea46eda6c341c1704ffe7bbbeefc946d2fee0cc8546c194db45c122bb75bb6b119a052d31c69942a757278a054ecc74ed63d8edde2c30c5a9beeec1e4e46
+  data.tar.gz: 40c84c04420569fd75259637863d6972673a6274f9599cbe24483cd6e3972e61d53e9ab4499e0c5fe538c30699f7b822dc107a16d1d59b183f3834377d5c29ec

data/README.md

@@ -0,0 +1,111 @@
+**fire-model** - 
+REST wrapper for **Firebase**.
+
+Setup Firebase
+```ruby
+Fire.setup(firebase_path: 'https://some-test-777.firebaseio.com')
+```
+
+Declare your Model
+```ruby
+class LibraryBook < Fire::Model
+  has_path_keys(:library, :floor, :row_number, :shelf)
+end
+```
+
+Use query syntax
+```ruby
+LibraryBook.create(library: 'Shevchenko', floor: 1, row_number: 1, shelf: 10, name: 'Kobzar', author: 'T.G. Shevchenko')
+LibraryBook.create(library: 'Shevchenko', floor: 1, row_number: 1, shelf: 15, name: 'Eneida', author: 'I. Kotlyrevskiy')
+LibraryBook.create(library: 'Shevchenko', floor: 2, row_number: 15, shelf: 115, name: 'Lord Of The Rings', author: ' J.R.R. Tolkien')
+LibraryBook.create(library: 'Skovoroda', floor: 1, row_number: 25, shelf: 34, name: 'Harry Potter', author: 'J.K. Rowling')
+LibraryBook.create(library: 'Skovoroda', floor: 2, row_number: 12, shelf: 15, name: 'Hobbit', author: ' J.R.R. Tolkien')
+
+LibraryBook.all.map(&:name)
+=> [ 'Kobzar', 'Eneida', 'Lord Of The Rings', 'Harry Potter', 'Hobbit' ]
+
+# Query by library
+LibraryBook.query(library: 'Shevchenko').map(&:name)
+=> [ 'Kobzar', 'Eneida', 'Lord Of The Rings' ]
+LibraryBook.query(library: 'Skovoroda').map(&:name)
+=> [ 'Harry Potter', 'Hobbit' ]
+
+# Query by library, floor
+LibraryBook.query(library: 'Shevchenko', floor: 1).map(&:name)
+=> [ 'Kobzar', 'Eneida' ]
+
+# Query by library, floor, row
+LibraryBook.query(library: 'Shevchenko', floor: 1, row_number: 1).map(&:name)
+=> [ 'Kobzar', 'Eneida' ]
+
+# Query by shelf
+LibraryBook.query(shelf: 15).map(&:name)
+=> [ 'Eneida', 'Hobbit' ]
+
+# Query by author
+LibraryBook.query(author: ' J.R.R. Tolkien').map(&:name) 
+=> [ 'Lord Of The Rings', 'Hobbit' ]
+
+# Query by math condition
+LibraryBook.query{|m| m.row_number % 5 == 0  }.map(&:name)
+=> [ 'Lord Of The Rings', 'Harry Potter' ]
+```
+Play with CRUD
+```ruby
+class Point < Fire::Model
+  has_path_keys(:x, :y)
+end
+
+p1 = Point.create(x: 1, y: 1, value: 1)
+p2 = Point.create(x: 1, y: 2, value: 2)
+p3 = Point.create(x: 2, y: 1, value: 3)
+p4 = Point.create(x: 1, y: 1, value: 4)
+
+Point.all.map(&:value)
+=> [ 1, 2, 3, 4 ]
+
+p1.value = 5
+p1.path_changed?
+=> false
+
+p1.save
+
+reloaded_point = Point.take(x: p2.x, y: p2.y, id: p2.id)
+reloaded_point.value = 6
+
+reloaded_point.path_changed?
+=> false
+
+reloaded_point.save
+
+p1.delete
+
+Point.all.map(&:value)
+=> [ 6, 3, 4]
+
+p3.x = 4
+p3.path_changed?
+=> true
+
+p3.save
+
+Point.all.map(&:value)
+=> [ 6, 3, 4]
+```
+
+
+**Contributing to fire-model**
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+**Copyright**
+
+Copyright (c) 2015 Vitaly Tarasenko. See LICENSE.txt for
+further details.
+

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.6

data/fire-model.gemspec

@@ -2,35 +2,39 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: fire-model 0.0.2 ruby lib
+# stub: fire-model 0.0.6 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "fire-model"
-  s.version = "0.0.2"
+  s.version = "0.0.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Vitaly Tarasenko"]
-  s.date = "2015-06-17"
+  s.date = "2015-06-19"
   s.description = "You can define your Firebase models, set collection names, CRUD your data.  "
   s.email = "vetal.tarasenko@gmail.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".document",
     "Gemfile",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.md",
     "Rakefile",
     "VERSION",
     "fire-model.gemspec",
     "lib/connection/request.rb",
     "lib/connection/response.rb",
     "lib/fire-model.rb",
-    "lib/model.rb",
-    "spec/models/fire_model_spec.rb",
+    "lib/model/model.rb",
+    "lib/model/nested/nested_model.rb",
+    "lib/model/nested/parent.rb",
+    "lib/model/querying/querying.rb",
+    "spec/models/main_spec.rb",
+    "spec/models/nested_models_spec.rb",
     "spec/spec_helper.rb"
   ]
   s.homepage = "http://github.com/tarvit/fire-model"

data/lib/fire-model.rb

@@ -1,7 +1,7 @@
 module Fire
   require 'connection/response'
   require 'connection/request'
-  require 'model'
+  require 'model/model'
 
   require 'ostruct'
 
@@ -17,7 +17,11 @@ module Fire
   end
 
   def self.drop!
-    Fire::Connection::Request.new.delete(?/)
+    connection.delete(?/)
+  end
+
+  def self.connection
+    Fire::Connection::Request.new
   end
 
   private

data/lib/{model.rb → model/model.rb}

@@ -7,7 +7,7 @@ module Fire
     include TarvitHelpers::NonSharedAccessors
     LEVEL_SEPARATOR = ?/
 
-    non_shared_cattr_accessor :fire_collection, :path_keys
+    non_shared_cattr_accessor :fire_collection, :path_keys, :id_key_name
 
     def initialize(attrs={})
       data = self.class.prepare_hash(attrs)
@@ -27,13 +27,17 @@ module Fire
       self.class.id_key
     end
 
+    def id_value
+      send(id_key)
+    end
+
     def collection_name
       self.class.collection_name
     end
 
     def save
       self.class.new(@original_data).delete if path_changed?
-      self.class.connection.set(path, self.data)
+      self.class.connection.set(path, self.saving_data)
       @persisted = true
     end
 
@@ -94,6 +98,10 @@ module Fire
       self.to_h
     end
 
+    def saving_data
+      data
+    end
+
     class << self
 
       # Klass Setters
@@ -106,6 +114,10 @@ module Fire
         self.path_keys = keys
       end
 
+      def set_id_key(value)
+        self.id_key_name = value
+      end
+
       # Klass Accessors
 
       def collection_name
@@ -126,42 +138,6 @@ module Fire
 
       # Record Methods
 
-      def query(params={}, &filter_condition)
-        path_values, selected_keys = [], []
-
-        own_path_keys.each do |key|
-          if params[key]
-            path_values << path_value_param(params[key])
-            selected_keys << key
-          else
-            break
-          end
-        end
-
-        full_path = ([ collection_name ] + path_values) * LEVEL_SEPARATOR
-        response = connection.get(full_path).body
-
-        return [] if response.nil?
-        result = response.values
-
-        (own_path_keys - selected_keys).count.times do
-          result = result.map(&:values).flatten.compact
-        end
-
-        filter = params.clone
-        selected_keys.each do |sk|
-          filter.delete(sk)
-        end
-
-        result.map{|data| new(data) }.select do |model_object|
-          not_filtered_by_attributes = model_object.has_data?(filter)
-          not_filtered_by_block = block_given? ? filter_condition.(model_object) : true
-          not_filtered_by_attributes && not_filtered_by_block
-        end
-      end
-
-      alias_method :all, :query
-
       def take(path_data)
         path_object = new(path_data)
         loaded_data = connection.get(path_object.path).body
@@ -190,7 +166,7 @@ module Fire
       end
 
       def id_key
-        :id
+        self.id_key_name || :id
       end
 
       protected
@@ -213,5 +189,16 @@ module Fire
       end
     end
 
+    class InvalidPathKeyError < FireModelError
+      def initialize(key, message=nil)
+        super (message || "Path key '#{ key }' is invalid")
+      end
+    end
+
+    require_relative './querying/querying'
+    require_relative './nested/parent'
+    require_relative './nested/nested_model'
+    include Querying
+    include Parent
   end
 end

data/lib/model/nested/nested_model.rb

@@ -0,0 +1,71 @@
+module Fire
+
+  class NestedModel < Model
+    non_shared_cattr_accessor :parent, :nested_options
+
+    def saving_data
+      res = data.clone
+      self.class.parent.all_path_keys.each do |k|
+        res.delete(k)
+      end
+      res
+    end
+
+    class << self
+      def in_collection(name)
+        raise CollectionIsSetError.new(self)
+      end
+
+      def has_path_keys(*keys)
+        raise ParentModelNotSetError.new(self) unless self.parent
+        super(*keys)
+        keys.each do |key|
+          raise DuplicatedParentPathKeyError.new(key, self.parent) if self.parent.all_path_keys.include?(key)
+        end
+      end
+
+      def nested_in(parent, options)
+        self.parent = parent
+        self.nested_options = OpenStruct.new(options)
+        self.parent.has_nested(self)
+      end
+
+      def own_path_keys
+        parent.all_path_keys + [ nested_options.folder ] + super()
+      end
+
+      def collection_name
+        parent.collection_name
+      end
+    end
+
+    def method_missing(*args)
+      if args.first.to_s == self.class.nested_options.folder
+        self.class.nested_options.folder
+      else
+        super
+      end
+    end
+
+    class DuplicatedParentPathKeyError < InvalidPathKeyError
+      def initialize(key, parent)
+        message = "Key '#{key}' is duplicated in a Parent Model '#{parent}'"
+        super(key, message)
+      end
+    end
+
+    class ParentModelNotSetError < FireModelError
+      def initialize(nested_model)
+        super("Nested Model '#{nested_model}' has no Parent Model set. Call `nested_in` to set a Parent.")
+      end
+    end
+
+    class CollectionIsSetError < FireModelError
+      def initialize(nested_model)
+        super("Nested Model '#{nested_model}' can not have own Collection. It is extended from Parent Model '#{nested_model.parent}'")
+      end
+    end
+
+  end
+
+end

data/lib/model/nested/parent.rb

@@ -0,0 +1,38 @@
+module Fire
+  class Model
+    module Parent
+      extend ActiveSupport::Concern
+
+      included do
+        non_shared_cattr_accessor :assigned_nested_models
+      end
+
+      module ClassMethods
+
+        def has_nested(nested_model)
+          self.assigned_nested_models ||= []
+          self.assigned_nested_models << nested_model
+
+          folder = nested_model.nested_options.folder
+          define_method "nested_#{folder}" do
+            objects = self.class.down_levels(send(folder), nested_model.path_keys.count)
+            objects.map{|x|
+              full_data = x.merge(self.path_data)
+              nested_model.new(full_data)
+            }
+          end
+
+          define_method "add_to_#{folder}" do |object|
+            nested_model.create(object.merge(self.path_data))
+          end
+        end
+
+        def nested_models
+          self.assigned_nested_models || []
+        end
+
+      end
+
+    end
+  end
+end

data/lib/model/querying/querying.rb

@@ -0,0 +1,54 @@
+module Fire
+  class Model
+    module Querying
+
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def query(params={}, &filter_condition)
+          path_values, selected_keys = [], []
+
+          own_path_keys.each do |key|
+            if params[key]
+              path_values << path_value_param(params[key])
+              selected_keys << key
+            else
+              break
+            end
+          end
+
+          full_path = ([ collection_name ] + path_values) * LEVEL_SEPARATOR
+          response = connection.get(full_path).body
+
+          return [] if response.nil?
+
+          result = down_levels(response, (own_path_keys - selected_keys).count)
+
+          filter = params.clone
+          selected_keys.each do |sk|
+            filter.delete(sk)
+          end
+
+          result.map{|data| new(data) }.select do |model_object|
+            not_filtered_by_attributes = model_object.has_data?(filter)
+            not_filtered_by_block = block_given? ? filter_condition.(model_object) : true
+            not_filtered_by_attributes && not_filtered_by_block
+          end
+        end
+
+        alias_method :all, :query
+
+        def down_levels(root, levels_count)
+          result = root.values
+
+          levels_count.times do
+            result = result.map(&:values).flatten.compact
+          end
+
+          result
+        end
+
+      end
+    end
+  end
+end

data/spec/models/{fire_model_spec.rb → main_spec.rb}

@@ -178,11 +178,12 @@ describe 'Fire Models' do
 
     context 'Updating' do
 
-      class Point < Fire::Model
-        has_path_keys(:x, :y)
-      end
+      it 'should update data (default ID key)' do
+
+        class Point < Fire::Model
+          has_path_keys(:x, :y)
+        end
 
-      it 'should update data' do
         p1 = Point.create(x: 1, y: 1, value: 1)
         p2 = Point.create(x: 1, y: 2, value: 2)
         p3 = Point.create(x: 2, y: 1, value: 3)
@@ -190,6 +191,8 @@ describe 'Fire Models' do
 
         expect(Point.all.map(&:value).sort).to eq([ 1, 2, 3, 4 ].sort)
 
+        expect(p1.id).to be
+
         p1.value = 5
         expect(p1.path_changed?).to be_falsey
         p1.save
@@ -216,6 +219,24 @@ describe 'Fire Models' do
         expect(Point.all.map(&:value).sort).to eq([ 6, 3, 4].sort)
       end
 
+      it 'should update data (custom ID key)' do
+        class Point < Fire::Model
+          has_path_keys(:x, :y)
+          set_id_key(:z)
+        end
+
+        p1 = Point.create(x: 1, y: 1, value: 1)
+        expect(p1.z).to be
+        expect(p1.id).to be_nil
+
+        p1.z = 10
+        p1.save
+
+        reloaded_point = Point.take(x: 1, y: 1, z: 10)
+
+        expect(reloaded_point).to eq(p1)
+      end
+
     end
 
   end

data/spec/models/nested_models_spec.rb

@@ -0,0 +1,162 @@
+require 'spec_helper'
+
+describe 'Nested Models' do
+
+  before :each do
+    Fire.drop!
+  end
+
+  after :each do
+    Fire.drop!
+  end
+
+  it 'should declare nested models' do
+
+    class Organization < Fire::Model
+      has_path_keys :country, :state
+      set_id_key(:name)
+    end
+
+    expect(Organization.nested_models).to be_empty
+
+    class Employee < Fire::NestedModel
+      nested_in Organization, folder: 'employees'
+      has_path_keys :department
+    end
+
+    expect(Organization.nested_models).to eq([ Employee ])
+
+    google = Organization.create(name: 'Google', country: 'USA', state: 'CA')
+    apple = Organization.create(name: 'Apple', country: 'USA', state: 'CA')
+
+    expect(current_data).to eq(
+        {'Organization'=>
+                {'usa'=>
+                     {'ca'=>
+                          {'apple'=>{'country'=>'USA', 'name'=>'Apple', 'state'=>'CA'},
+                           'google'=>{'country'=>'USA', 'name'=>'Google', 'state'=>'CA'}}}}})
+
+    larry = Employee.create(name: 'Google', country: 'USA', state: 'CA',
+                    department: 'HQ', full_name: 'Larry Page', position: 'CEO')
+
+    expect(current_data).to eq(
+        {'Organization'=>
+             {'usa'=>
+                  {'ca'=>
+                       {'apple'=>{'country'=>'USA', 'name'=>'Apple', 'state'=>'CA'},
+                        'google'=>{
+                            'country'=>'USA', 'name'=>'Google', 'state'=>'CA', 'employees' => {
+                                'hq' => {
+                                    larry.id => {
+                                        'id' => larry.id,
+                                        'full_name' => 'Larry Page',
+                                        'position' => 'CEO',
+                                        'department' => 'HQ',
+                                    }}}}}}}})
+
+    google = Organization.query(name: 'Google').first
+    google.nested_employees
+
+    employee = google.nested_employees.first
+    expect(larry).to eq(employee)
+
+    employee.department = 'Research'
+    employee.save
+
+    expect(current_data).to eq(
+        {'Organization'=>
+             {'usa'=>
+                  {'ca'=>
+                       {'apple'=>{'country'=>'USA', 'name'=>'Apple', 'state'=>'CA'},
+                        'google'=>{
+                            'country'=>'USA', 'name'=>'Google', 'state'=>'CA', 'employees' => {
+                                'research' => {
+                                    larry.id => {
+                                        'id' => larry.id,
+                                        'full_name' => 'Larry Page',
+                                        'position' => 'CEO',
+                                        'department' => 'Research',
+                                    }}}}}}}})
+
+    apple = Organization.query(name: 'Apple').first
+    tim = apple.add_to_employees(
+      full_name: 'Tim Cook',
+      position: 'CEO',
+      department: 'HQ'
+    )
+
+    expect(current_data).to eq(
+        {'Organization'=>
+             {'usa'=>
+                  {'ca'=>
+                       {'apple'=>
+                            {'country'=>'USA',
+                             'employees'=>
+                                 {'hq'=>
+                                      {tim.id=>
+                                           {'department'=>'HQ',
+                                            'full_name'=>'Tim Cook',
+                                            'id'=>tim.id,
+                                            'position'=>'CEO'}}},
+                             'name'=>'Apple',
+                             'state'=>'CA'},
+                        'google'=>
+                            {'country'=>'USA',
+                             'employees'=>
+                                 {'research'=>
+                                      {larry.id=>
+                                           {'department'=>'Research',
+                                            'full_name'=>'Larry Page',
+                                            'id'=>larry.id,
+                                            'position'=>'CEO'}}},
+                             'name'=>'Google',
+                             'state'=>'CA'}}}}}
+    )
+  end
+
+  context 'Restrictions' do
+    before :all do
+
+      class Hotel < Fire::Model
+        has_path_keys :location, :class
+        set_id_key(:name)
+      end
+
+    end
+
+    it 'should not allow to set path keys if parent model is not set' do
+      expect(->{
+        class Room < Fire::NestedModel
+          has_path_keys :number
+        end
+      }).to raise_error(Fire::NestedModel::ParentModelNotSetError)
+
+      expect(->{
+        class Room < Fire::NestedModel
+          nested_in Hotel, folder: 'rooms'
+          has_path_keys :number
+        end
+      }).to be
+    end
+
+    it 'should not allow to declare duplicated path keys in nested models' do
+      expect(->{
+        class Room < Fire::NestedModel
+          nested_in Hotel, folder: 'rooms'
+          has_path_keys :number, :class
+        end
+      }).to raise_error(Fire::NestedModel::DuplicatedParentPathKeyError)
+
+      expect(->{
+        class Room < Fire::NestedModel
+          has_path_keys :number, :room_class
+        end
+      }).to be
+    end
+  end
+
+  def current_data
+    Fire.connection.get(?/).body
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fire-model
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.6
 platform: ruby
 authors:
 - Vitaly Tarasenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-17 00:00:00.000000000 Z
+date: 2015-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tarvit-helpers
@@ -143,20 +143,24 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
+- README.md
 files:
 - .document
 - Gemfile
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - fire-model.gemspec
 - lib/connection/request.rb
 - lib/connection/response.rb
 - lib/fire-model.rb
-- lib/model.rb
-- spec/models/fire_model_spec.rb
+- lib/model/model.rb
+- lib/model/nested/nested_model.rb
+- lib/model/nested/parent.rb
+- lib/model/querying/querying.rb
+- spec/models/main_spec.rb
+- spec/models/nested_models_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/tarvit/fire-model
 licenses:

data/README.rdoc

@@ -1,19 +0,0 @@
-= fire-model
-
-Description goes here.
-
-== Contributing to fire-model
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2015 Vitaly Tarasenko. See LICENSE.txt for
-further details.
-