nested_record 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e0e28260ca8d52235022d6ebcb471d6ea5cb585ebe4391bb4bc76ef47166d8a
-  data.tar.gz: 73413b02eb3c334060f3098254e53c0795546ca1875df2874a7f99a8f4a5c9b0
+  metadata.gz: f4736181e42c531aad96202018bb79f79ec46aa69a0cf03a0a991abead29f4af
+  data.tar.gz: 7aa80b14123c4c8b1e8175d9ff5d187b6918d31ff0f1521a394ebd061d7b14cf
 SHA512:
-  metadata.gz: c665c138f57fed85d36071e6decb469e3e5488203cac1f604920f61978ddab323e2be3c16d689c8ba01db514ab04d072528531e1d59bcbadab086eeabe3dec13
-  data.tar.gz: cd2bda40861ee824ba6adae759d03fdb0582b4c49b1f18c39fbcdb3f649864be1e41e8c834a9eddaa2a16970dd807724d5510f00b921ad9472a796b733338453
+  metadata.gz: f02b179664dc676bd35d4e6087194f714d58d56cf88058ea7d739be48e34ec330a1df0a2dd197eb2ed58579757331af7d13b6133ceae5a768f6b07773be0c32b
+  data.tar.gz: cffc632808753b0ecc39e2400328c42776f7a503e77f7373085438003c4efc3907d5d4a426737660875a611b22c0ce860f8eeb41b79edb1dd921dbafb7b11538

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nested_record (0.1.0)
+    nested_record (0.1.1)
       rails (~> 5.2)
 
 GEM

data/README.md

@@ -1,8 +1,6 @@
 # NestedRecord
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/nested_record`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This gem is for mapping of json fields on `ActiveModel` objects!
 
 ## Installation
 
@@ -22,7 +20,90 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Use `nested_record` to define nested associations on `ActiveRecord` models via JSON attributes.
+
+First add `json` column into your database:
+
+```ruby
+change_table :users do |t|
+  t.json :profile
+end
+```
+
+Then define association using `has_one_nested` macro:
+
+```ruby
+class User < ActiveRecord::Base
+  include NestedRecord::Macro
+
+  has_one_nested :profile
+end
+```
+
+Or you can include the `Macro` globally:
+
+```ruby
+class ApplicationRecord < ActiveRecord::Base
+  include NestedRecord::Macro
+end
+
+class User < ApplicationRecord
+  has_one_nested :profile
+end
+```
+
+Define nested record attributes using `ActiveModel::Attributes` API (since Rails 5.2):
+
+```ruby
+class Profile < NestedRecord::Base
+  attribute :age,    :integer
+  attribute :active, :boolean
+  has_one_nested :contacts
+end
+```
+
+You can go deeper and define models on the next nesting level:
+
+```ruby
+class Profile::Contacts < NestedRecord::Base
+  attribute :email, :string
+  attribute :phone, :string
+end
+```
+
+You can store **a collection** of objects with `has_many_nested`:
+
+```ruby
+class Profile::Contacts < NestedRecord::Base
+  attribute :email, :string
+  attribute :phone, :string
+  has_many_nested :socials
+end
+
+class Profile::Social < NestedRecord::Base
+  attribute :name
+  attribute :url
+end
+
+user.profile.age = 39
+user.profile.contacts.email = 'john@doe.com'
+user.profile.contacts.socials[0].name # => 'facebook'
+```
+
+You can assign attributes in the way like `accepts_nested_attributes_for` macros provides for AR models:
+
+```ruby
+user.profile_attributes = {
+  age: 39,
+  contacts_attributes: {
+    email: 'john@doe.com',
+    socials_attributes: [
+      { name: 'facebook', url: 'facebook.example.com/johndoe' },
+      { name: 'twitter', url: 'twitter.example.com/johndoe' }
+    ]
+  }
+}
+```
 
 ## Development
 
@@ -32,7 +113,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/nested_record.
+Bug reports and pull requests are welcome on GitHub at https://github.com/marshall-lee/nested_record.
 
 ## License
 

data/lib/nested_record/collection.rb

@@ -63,6 +63,10 @@ class NestedRecord::Collection
     @ary.length
   end
 
+  def size
+    @ary.size
+  end
+
   def select!
     return to_enum(:select!) unless block_given?
     @ary.select!(&proc)
@@ -75,6 +79,12 @@ class NestedRecord::Collection
     self
   end
 
+  def sort_by!
+    return to_enum(:sort_by!) unless block_given?
+    @ary.sort_by!(&proc)
+    self
+  end
+
   def reject_by!(attrs)
     return to_enum(:reject_by!) unless block_given?
     attrs = attrs.stringify_keys

data/lib/nested_record/setup.rb

@@ -4,7 +4,12 @@ class NestedRecord::Setup
   def initialize(owner, name, **options, &extension)
     @options = options
     @owner = owner
-    @record_class = options[:class_name] || name.to_s.classify
+    if options[:class_name]
+      @record_class = options[:class_name]
+    else
+      @record_class = name.to_s.camelize
+      @record_class = @record_class.singularize if self.is_a?(HasMany)
+    end
     @name = name
     @extension = extension
 

data/lib/nested_record/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NestedRecord
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/spec/nested_record/collection_spec.rb

@@ -24,4 +24,25 @@ RSpec.describe NestedRecord::Collection do
       expect { collection << Bar.new }.not_to raise_error
     end
   end
+
+  describe '#sort_by!' do
+    it 'sorts collection' do
+      collection << Foo.new(id: 2)
+      collection << Foo.new(id: 1)
+
+      collection.sort_by!(&:id)
+      expect(collection.map(&:id)).to eq [1, 2]
+    end
+  end
+
+  describe '#size' do
+    it 'works' do
+      expect(collection.size).to eq 0
+
+      collection << Foo.new(id: 2)
+      collection << Foo.new(id: 1)
+
+      expect(collection.size).to eq 2
+    end
+  end
 end

data/spec/nested_record_spec.rb

@@ -37,6 +37,22 @@ RSpec.describe NestedRecord do
       end
     end
 
+    context 'with plural model name' do
+      nested_model(:Points) do
+        attribute :x, :string
+        attribute :y, :integer
+        attribute :z, :boolean
+      end
+
+      active_model(:Foo) do
+        has_one_nested :points
+      end
+
+      it 'properly locates the model class' do
+        expect(Foo.new.build_points).to be_an_instance_of(Points)
+      end
+    end
+
     describe 'writer' do
       it 'is defined' do
         foo = Foo.new

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nested_record
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Vladimir Kochnev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-25 00:00:00.000000000 Z
+date: 2019-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler