fire-model 0.0.15 → 0.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eeeadf3f741c62914fe9dec55ab94e35051aea77
-  data.tar.gz: f0ce83cc0485c7da731d0415f8e2a1af98a0f747
+  metadata.gz: 3fdb250be82593bbccbf6d91e9f68d48cb0a5e66
+  data.tar.gz: 00c3883855b7cceca2cae97d5fd08416f7ec9524
 SHA512:
-  metadata.gz: d598e6c1435655359764f0da9694f0adfec08853d6f88ff9db3935053f405f4d066185c9f27037009f6bf1073b56562bdfeabba8c336ab48e0a2bf212fb2df02
-  data.tar.gz: 3d5342b8cbe8bf7584798654107643555a0f73245feeb523fa39fe007f85ba1b25640e214ddb21bcc5c60509a742a7989ad02720c120dc4a142b73c21db7cc81
+  metadata.gz: c90e0dd13ee9b87a69bcda662958df06308607c648907c9f67a96cef3e6b23520f88ceecafaf8e486d4db1ceda561a0a710e71240924df1e11d4eed4690843be
+  data.tar.gz: 658af712fb067d30cfacfb60695fe3637365bc2970fd5dc8cf6937b10fd5a6a9fd3209dc3675a79adbf69ff2cc340124c024c4784c574614b8c8e5589c25492b

data/README.md

@@ -1,8 +1,13 @@
 # fire-model - REST wrapper for Firebase.
 
+Install gem
+```
+gem install fire-model
+```
 
-Setup Firebase
+Setup Firebase. (If you are using Rails create a file `Rails.root/config/initializers/fire_model.rb` and put next line there)
 ```ruby
+require 'fire-model'
 Fire.setup(firebase_path: 'https://some-test-777.firebaseio.com')
 ```
 
@@ -101,8 +106,8 @@ Point.all.map(&:value)
 Create Nested Models
 ```ruby
 class Organization < Fire::Model
-  has_path_keys :country, :state
   set_id_key(:name)
+  has_path_keys :country, :state
 end
 
 class Employee < Fire::NestedModel
@@ -176,7 +181,8 @@ car = Car.create(manufacturer: 'Zaporozhets', model: 'ZAZ-965', car_class: 'Mini
   engine: { code: 'MeMZ-966' })
 
 zaporozhets = Car.take(manufacturer: 'Zaporozhets', model: 'ZAZ-965', car_class: 'Mini', id: car.id)
-expect(zaporozhets.nested_engine.code).to eq('MeMZ-966')
+zaporozhets.nested_engine.code
+=> 'MeMZ-966'
 
 Fire.tree
 => {
@@ -209,13 +215,13 @@ zaporozhets.nested_engine.reload.code
 Nested Models with Parent`s values
 ```ruby
 class House < Fire::Model
-  has_path_keys :country, :city, :street
   set_id_key(:house_number)
+  has_path_keys :country, :city, :street
 end
 
 class Room < Fire::NestedModel
-  nested_in House, parent_values: true
   set_id_key(:number)
+  nested_in House, parent_values: true
   has_path_keys :floor
 end
 
@@ -227,7 +233,8 @@ house.add_to_rooms(floor: 150, number: '2A')
 
 
 rooms = house.reload.nested_rooms
-expect(rooms.map(&:number).sort).to eq(%w{ 1A 2A }.sort)
+rooms.map(&:number)
+=> [ '1A', '2A' ]
 
 Fire.tree
 =>  {'House'=>

data/VERSION

@@ -1 +1 @@
-0.0.15
+0.0.16

data/fire-model.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: fire-model 0.0.15 ruby lib
+# stub: fire-model 0.0.16 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "fire-model"
-  s.version = "0.0.15"
+  s.version = "0.0.16"
 
   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-21"
+  s.date = "2015-06-24"
   s.description = "You can define your Firebase models, set collection names, CRUD your data.  "
   s.email = "vetal.tarasenko@gmail.com"
   s.extra_rdoc_files = [

data/lib/model/nested/base.rb

@@ -29,6 +29,16 @@ module Fire
       self.class.nested_options
     end
 
+    def self.id_key
+      self.id_key_name || "#{self.name.demodulize.singularize.dasherize.downcase}_id".to_sym
+    end
+
+    def set_id_key(value)
+      raise ParentModelNotSetError.new(self) unless self.parent
+      validate_id_key!
+      super(value)
+    end
+
     class << self
       def in_collection(name)
         raise CollectionIsSetError.new(self)
@@ -46,6 +56,7 @@ module Fire
         self.parent = parent
         self.nested_options = OpenStruct.new(options)
         self.parent.has_nested(self)
+        validate_id_key!
       end
 
       def own_path_keys
@@ -81,7 +92,11 @@ module Fire
       protected
 
       def default_folder_name
-        name.pluralize
+        name.demodulize.pluralize.dasherize
+      end
+
+      def validate_id_key!
+        raise DuplicatedIdKeyError.new(self.id_key, self.parent) if self.parent.all_path_keys.include?(id_key)
       end
     end
 
@@ -95,9 +110,21 @@ module Fire
 
     class DuplicatedParentPathKeyError < InvalidPathKeyError
       def initialize(key, parent)
-        message = "Key '#{key}' is duplicated in a Parent Model '#{parent}'"
+        message = error_message(key, parent)
         super(key, message)
       end
+
+      def error_message(key, parent)
+        "Key '#{key}' is duplicated in a Parent Model '#{parent}'"
+      end
+    end
+
+    class DuplicatedIdKeyError < DuplicatedParentPathKeyError
+
+      def error_message(key, parent)
+        "ID Key '#{key}' is duplicated in a Parent Model '#{parent}'. Use 'set_key_id' method to define a specific ID Key"
+      end
+
     end
 
     class ParentModelNotSetError < FireModelError

data/lib/model/nested/single.rb

@@ -14,6 +14,14 @@ module Fire
         new(parent_original.clone.merge(parent.path_data), parent_original)
       end
 
+      def id_key
+        parent.id_key
+      end
+
+      def set_id_key(value)
+        raise IdKeyNotSupported.new(self)
+      end
+
       protected
 
       def default_path_keys
@@ -30,6 +38,16 @@ module Fire
         end
       end
 
+      def validate_id_key!
+        true
+      end
+
+    end
+
+    class IdKeyNotSupported < FireModelError
+      def initialize(single_nested_model)
+        super("Single Model #{single_nested_model} don't support own ID key.")
+      end
     end
 
     class PathKeysNotSupported < FireModelError

data/spec/models/nested_models_spec.rb

@@ -26,6 +26,7 @@ describe 'Nested Models' do
       expect(Organization.nested_models).to be_empty
 
       class Employee < Fire::NestedModel
+        set_id_key(:id)
         nested_in Organization
         has_path_keys :department
       end
@@ -161,6 +162,7 @@ describe 'Nested Models' do
         end
 
         class Engine < Fire::SingleNestedModel
+
           nested_in Car
         end
 
@@ -265,6 +267,32 @@ describe 'Nested Models' do
     end
   end
 
+  context 'Relations' do
+
+    before :all do
+      class Post < Fire::Model
+        has_path_keys :category
+
+        class Comment < Fire::NestedModel
+          nested_in Post
+        end
+      end
+    end
+
+    it 'should be associated' do
+      expect(Post.id_key).to eq(:id)
+      expect(Post::Comment.id_key).to eq(:comment_id)
+      expect(Post::Comment.folder).to eq('comments')
+
+      post = Post.create(category: 'default')
+      post.add_to_comments(text: 'hello')
+      post.add_to_comments(text: 'hey')
+
+      expect(post.reload.nested_comments.map(&:text).sort).to eq(%w{ hello hey }.sort)
+    end
+
+  end
+
   context 'Restrictions' do
     before :each do
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fire-model
 version: !ruby/object:Gem::Version
-  version: 0.0.15
+  version: 0.0.16
 platform: ruby
 authors:
 - Vitaly Tarasenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-21 00:00:00.000000000 Z
+date: 2015-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tarvit-helpers