embedded 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5b50128771dd929a10a666a66162b6d474cae251
-  data.tar.gz: ab834feb4633a90efd4e74e6cc8ad6605bc7685c
+SHA256:
+  metadata.gz: c7c55c2185e856455dc2901abd80f43fd4dc5a274c72dd3ad9681bf3f82484e8
+  data.tar.gz: 349aa11195724eb96a93f7933a44b947138458d9c6641dc99a78c3b5b8819b86
 SHA512:
-  metadata.gz: ec6877b0001ab2025c75dd53f7aefb8dd6244d91b9a429bf262801e04317a0d8785f2d9bd3b384adc78c50bb288c65b48928de616c3a2424e9d0d206f0abc54a
-  data.tar.gz: 7250302a6d36404c2d77f070f9ecf092d5283a538556e4140475a504f5772ce841837e59a2b15e70a5861ae03129f633c60c91e05fbc9048e5392e37aee13505
+  metadata.gz: 4e3d49cdb279870a5228ff6e0fdc825abb1e2051d7ee6d56c29b7ac36367d81a2773efd5f88fed86d22dd713bb2cd7842704e92fcf267a21ab131717a6a29038
+  data.tar.gz: 2518c1636bb977e9c595401524ef80341160d66948cededd21257a5f0cf7cb037cb4ec1027a6984da3ce8dfaab441fabd735ea58e5a3a173d9443964fcdd6fbb

data/README.md

@@ -2,15 +2,18 @@
 
 Embedded is a small rails engine to correctly persist Value Objects in Active Record Object columns
 
+## Code Status
+[![Build Status](https://travis-ci.org/jvillarejo/embedded.svg?branch=master)](https://travis-ci.org/jvillarejo/embedded)
+
 ## Motivation
 
-There objects in every domain that doesn't have an identity by itself but their equality depends on the values of their attributes.
+There are objects in every domain that don't have an identity by themselves but in which their equality depends on the values of their attributes.
 
 Example: prices, any magnitude, a color, a polygon.
 
-Defining a value objects lets you extract common behavior from your current bloated active record objects.
+Defining a value object lets you extract common behavior from your current bloated active record objects.
 
-Every time that I did this I had to define a getter and setter for the value object and map those to the columns of the object that gets persisted, so I thought it would be better to define those value object attributes in a declarative way and let the plugin do the magic behind.
+Every time I did this, I had to define a getter and a setter for the value object, and map those to the columns of the object that gets persisted, so I thought that it would be better to define those value object attributes in a declarative way and let the plugin do the magic behind.
 
 For more info about value objects check this links:
 
@@ -48,7 +51,7 @@ end
 
 ## Usage
 
-Let's say you have a Reservation in your active record model and that reservation has a start_time, and end_time. And want you calculate the duration in hours of the period.
+Let's say you have a Reservation in your active record model and that it has a start_time and an end_time. And that you want to calculate the duration in hours of the period.
 
 ```ruby
   class Reservation < ApplicationRecord
@@ -83,7 +86,7 @@ Let's say you have a Reservation in your active record model and that reservatio
   # => 3
 ```
 
-Now you are starting to see the problem. That behavior belongs to a TimeInterval object that has start_time and end_time and let's you calculate all durations and intervals you want.
+Now you are starting to see the problem. That behavior belongs to a TimeInterval object that has a start_time an end_time and let's you calculate all the durations and intervals you want.
 
 So with embedded in hand we can do this.
 
@@ -137,7 +140,7 @@ Now you can pass available time to shop constructor and check the duration direc
   shop.available_time.hours
   # => 3
 ```
-Also you can persist the reservation and when fetching it back of the db it will scheduled_time will be a TimeInterval
+Also you can persist the reservation, and when fetching it back from the db its scheduled_time will be a TimeInterval
 
 ```ruby
   t = TimeInterval.new(start_time: Time.now, end_time: 3.hours.ago)
@@ -153,7 +156,7 @@ Also you can persist the reservation and when fetching it back of the db it will
 
 Your table columns have to be named in a specific way so they are mapped correctly, for example:
 
-Reservation attribute name is scheduled_time and as TimeInterval has start_time and end_time your column names must be defined as scheduled_time_start_time and scheduled_time_end_time
+If Reservation attribute name is scheduled_time and its TimeInterval has start_time and end_time attributes, your column names should be defined as followed:
 
 ```ruby
 class CreateReservations < ActiveRecord::Migration
@@ -168,7 +171,7 @@ class CreateReservations < ActiveRecord::Migration
 end
 ```
 
-Shop attribute name is available time and as TimeInterval has start_time and end_time attributes, your column names here must be defined as available_time_start_time and available_time_end_time
+Shop attribute name is available time, and its TimeInterval has start_time and end_time attributes. Your column names here must be like this:
 
 ```ruby
 class CreateShops < ActiveRecord::Migration
@@ -195,7 +198,7 @@ bubble_price = Price.new(currency: 'USD', amount: BigDecimal.new('5257'))
 my_intelligent_investment = SellOrder.create(price: price, created_at: Time.new(2017,10,18))
 ```
 
-And we want to check the orders for a specific price we can do this.
+And if we want to check the orders for a specific price we can do it like this:
 
 ```ruby
 price = Price.new(currency: 'BTC', amount: BigDecimal.new('2.5'))
@@ -204,9 +207,9 @@ gambles = BuyOrder.embedded.where(price: price).to_a
 # => [#<Order id: 1, price_currency: "BTC", price_amount: #<BigDecimal:555e61776630,'0.25E1',18(36)>, created_at: "2017-03-17 17:11:00", updated_at: "2017-10-18 17:11:00">]
 ```
 
-In order to search with values you should specify with embedded method. This decision was made because I didn't want to monkey patch the activerecord method 'where'.
+In order to search with value objects you should use embedded method. This decision was made because I didn't want to monkey patch the activerecord method 'where'.
 
-With this way the embedded method returns another scope in which the method 'where' is overridden. If you want to query by the column attributes you can still use the default 'where' method. 
+This way the embedded method returns another scope in which the method 'where' is overridden. If you want to query by the column attributes you can still use the default 'where' method. 
 
 ```ruby
 jpm_orders = BuyOrder.where(price_currency: 'BTC')
@@ -215,7 +218,7 @@ jpm_orders.find_each {|o| o.trader.fire! }
 
 ## Contributing
 
-Everyone is encouraged to help improve this project. Here are a few ways you can help:
+Everyone is encouraged to help to improve this project. Here are a few ways you can help:
 
 - [Report bugs](https://github.com/jvillarejo/embedded/issues)
 - Fix bugs and [submit pull requests](https://github.com/jvillarejo/embedded/pulls)

data/Rakefile

@@ -1,33 +1,10 @@
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-
-require 'rdoc/task'
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Embedded'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-
-
-
-
-
-require 'bundler/gem_tasks'
-
-require 'rake/testtask'
+require "bundler/gem_tasks"
+require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
 end
 
-
-task default: :test
+task :default => :test

data/lib/embedded/model.rb

@@ -10,9 +10,11 @@ module Embedded
       Embedded::Scope.new(self.all,embedded_attributes)
     end
 
+    def embedded_attributes
+      @embedded_attributes ||= {}
+    end
+
     def embeds(embeddable_attr, options = {})
-      cattr_accessor :embedded_attributes
-      self.embedded_attributes ||= {}
       self.embedded_attributes[embeddable_attr] = options
 
       attributes = options[:attrs]
@@ -28,7 +30,7 @@ module Embedded
 
       self.send(:define_method, :"#{embeddable_attr}=") do |v|
         columns.each do |k,a|
-          self.write_attribute(k, v.send(a))
+          write_attribute(k, v.send(a))
         end
       end
     end

data/lib/embedded/version.rb

@@ -1,3 +1,3 @@
 module Embedded
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,29 +1,77 @@
 --- !ruby/object:Gem::Specification
 name: embedded
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - jvillarejo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-18 00:00:00.000000000 Z
+date: 2018-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +86,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
 description: Rails plugin that makes value objects embedded into activerecord objects
 email:
 - arzivian87@gmail.com
@@ -72,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Use value objects with activerecord objects