artirix_data_models 0.11.2 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 74bf1987943e0d0d547849475fa2c49e6680ba55
-  data.tar.gz: b5cf434cc9e5a3f69da2c20b9f103140a76ac215
+  metadata.gz: e693f7a79fd0435a53c7315a66a0a87fddc00756
+  data.tar.gz: 1e2209be29d0228f38187d74079570b5d8326af6
 SHA512:
-  metadata.gz: 8683e1313088cade6522eb60185217e42a2ea614abc490b6e39c541ca04b090a472510698b285dbfb2079a6326ee71f40bef43a048f9f00fb1a0c33367f9f1c1
-  data.tar.gz: c2bf55255fb00cf74ba913aa25e23534809d07703c551fe40d7ae56187715575c51a3037932b28f68409571b17b2bdf2a15526ad4fcf28d690062c6b5d392fe7
+  metadata.gz: c51a77d2635bdbf0a2c32fb1a89caa6c63dc31d5e6980d388092287f7f31a5682b60c5f7e55636bfc8eee40c69372b7e7afb12a257c8a855bfe2827003149486
+  data.tar.gz: 29814e119cfe07b7b26390d7bf1132b0ed9f6b749d035303816b1c58b9b14aecf0a00226bdf06da2a40a249aa90af5598d346020327df1f1cde00e4c412d7f61

data/README.md

@@ -52,6 +52,24 @@ end
 
 TODO:
 
+```ruby
+
+class MyModel
+  include ArtirixDataModels::Model::OnlyData
+
+  attribute :id, :name
+
+  attribute :public_title, writer_visibility: :public
+  attribute :private_title, reader_visibility: :private
+
+  attribute :remember_me, :and_me, skip: :predicate
+  attribute :remember_me2, :and_me2, skip: :presence
+
+end
+
+
+```
+
 ### DAO
 
 TODO:
@@ -250,6 +268,9 @@ end
 
 ## Changes
 
+### 0.12.0
+- `attribute` call now can accept a hash of options as the last argument. This options include: `skip` (what to skip), `writer_visibility` and `reader_visibility`.
+
 ### 0.11.2
 - `ArtirixDataModels::ActiveNull` better acting like a model.
 

data/lib/artirix_data_models/model.rb

@@ -151,7 +151,8 @@ module ArtirixDataModels
 
       module ClassMethods
         def attribute(*attributes)
-          attributes.each { |attribute| _define_attribute attribute }
+          options = attributes.extract_options!
+          attributes.each { |attribute| _define_attribute attribute, options }
         end
 
         def attribute_config
@@ -181,44 +182,56 @@ module ArtirixDataModels
         end
 
         private
-        def _define_attribute(attribute)
+        def _define_attribute(attribute, options)
           at = attribute.to_sym
-          _define_getter(at)
-          _define_presence(at)
-          _define_writer(at)
+          _define_getter(at, options)
+          _define_presence(at, options)
+          _define_writer(at, options)
 
           attribute_config.add_attribute at
         end
 
-        def _define_writer(attribute)
+        def _define_writer(attribute, options)
+          skip_option = Array(options.fetch(:skip, []))
+          return nil if skip_option.include?(:writer) || skip_option.include?(:setter)
+
+          vis = options.fetch(:writer_visibility, writer_visibility)
+
           attr_writer attribute
           writer = "#{attribute}="
 
-          if writer_visibility == :private
+          if vis == :private
             private writer
-          elsif writer_visibility == :protected
+          elsif vis == :protected
             protected writer
           end
 
           writer
         end
 
-        def _define_presence(attribute)
+        def _define_presence(attribute, options)
+          skip_option = Array(options.fetch(:skip, []))
+          return nil if skip_option.include?(:presence) || skip_option.include?(:predicate)
+
           presence_method = "#{attribute}?"
           define_method presence_method do
             send(attribute).present?
           end
         end
 
-        def _define_getter(attribute)
+        def _define_getter(attribute, options)
+          skip_option = Array(options.fetch(:skip, []))
+          return nil if skip_option.include?(:reader) || skip_option.include?(:getter)
+
           variable_name = "@#{attribute}"
           dir_get_name  = Attributes.direct_getter_method_name(attribute)
+          reader        = attribute.to_s
 
           define_method dir_get_name do
             instance_variable_get variable_name
           end
 
-          define_method(attribute) do
+          define_method(reader) do
             val = send dir_get_name
             if val.nil?
               nil_attribute(attribute)
@@ -226,6 +239,15 @@ module ArtirixDataModels
               val
             end
           end
+
+          vis = options.fetch(:reader_visibility, :public)
+
+          if vis == :private
+            private reader
+          elsif vis == :protected
+            protected reader
+          end
+
         end
       end
 

data/lib/artirix_data_models/version.rb

@@ -1,3 +1,3 @@
 module ArtirixDataModels
-  VERSION = '0.11.2'
+  VERSION = '0.12.0'
 end

data/spec/artirix_data_models/model_spec.rb

@@ -0,0 +1,124 @@
+require 'spec_helper'
+
+class MyModel
+  include ArtirixDataModels::Model::OnlyData
+
+  attribute :id, :name
+
+  attribute :public_title, writer_visibility: :public
+  attribute :private_title, reader_visibility: :private
+
+  attribute :remember_me, :and_me, skip: :predicate
+  attribute :remember_me2, :and_me2, skip: :presence
+
+end
+
+RSpec.describe MyModel, type: :model do
+
+  subject { described_class.new data }
+
+  let(:data) do
+    {
+      name:         name,
+      remember_me:  remember_me,
+      and_me:       and_me,
+      remember_me2: remember_me2,
+      and_me2:      and_me2,
+    }
+  end
+
+  let(:name) { 'Paco' }
+  let(:remember_me) { 'yeah' }
+  let(:and_me) { 'and' }
+  let(:remember_me2) { 'other' }
+  let(:and_me2) { 'stuff' }
+
+  describe '.attribute' do
+    it 'creates public getter' do
+      expect(subject).to respond_to :id
+      expect(subject).to respond_to :name
+    end
+
+    it 'loads info from hash passed in object creation' do
+      expect(subject.id).to be_nil
+      expect(subject.name).to eq name
+    end
+
+    it 'creates private setter' do
+      expect(subject.respond_to? :name=).to be_falsey
+      expect(subject.respond_to? :name=, true).to be_truthy
+
+      expect(subject.name).to eq name
+      subject.send :name=, 123
+      expect(subject.name).to eq 123
+    end
+
+    it 'creates predicate method' do
+      expect(subject).to respond_to :id?
+      expect(subject).to respond_to :name?
+
+      expect(subject.id?).to be_falsey
+      expect(subject.name?).to be_truthy
+    end
+
+    it 'creates private setter' do
+      expect(subject.respond_to? :name=).to be_falsey
+      expect(subject.respond_to? :name=, true).to be_truthy
+
+      expect(subject.name).to eq name
+      subject.send :name=, 123
+      expect(subject.name).to eq 123
+    end
+
+    context 'with option `writer_visibility: :public`' do
+      it 'writer is public' do
+        expect(subject.respond_to? :public_title=).to be_truthy
+        expect(subject.respond_to? :public_title=, true).to be_truthy
+
+        expect(subject.public_title).to be_nil
+        subject.public_title = 411
+        expect(subject.public_title).to eq 411
+      end
+    end
+
+    context 'with option `reader_visibility: :private`' do
+      it 'reader is private' do
+        expect(subject.respond_to? :private_title).to be_falsey
+        expect(subject.respond_to? :private_title, true).to be_truthy
+
+        expect(subject.send :private_title).to be_nil
+        subject.send :private_title=, 411
+        expect(subject.send :private_title).to eq 411
+      end
+    end
+
+    context 'with option `skip: :predicate` or `skip: :presence`' do
+
+      it 'does not create predicate method' do
+        expect(subject).to respond_to :remember_me
+        expect(subject).to respond_to :and_me
+        expect(subject).to respond_to :remember_me2
+        expect(subject).to respond_to :and_me2
+
+        #not public
+        expect(subject.respond_to? :remember_me?).to be_falsey
+        expect(subject.respond_to? :and_me?).to be_falsey
+        expect(subject.respond_to? :remember_me2?).to be_falsey
+        expect(subject.respond_to? :and_me2?).to be_falsey
+
+        #not private either
+        expect(subject.respond_to? :remember_me?, true).to be_falsey
+        expect(subject.respond_to? :and_me?, true).to be_falsey
+        expect(subject.respond_to? :remember_me2?, true).to be_falsey
+        expect(subject.respond_to? :and_me2?, true).to be_falsey
+
+        expect(subject.remember_me).to eq remember_me
+        expect(subject.and_me).to eq and_me
+        expect(subject.remember_me2).to eq remember_me2
+        expect(subject.and_me2).to eq and_me2
+      end
+
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: artirix_data_models
 version: !ruby/object:Gem::Version
-  version: 0.11.2
+  version: 0.12.0
 platform: ruby
 authors:
 - Eduardo Turiño
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-22 00:00:00.000000000 Z
+date: 2016-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -274,6 +274,7 @@ files:
 - spec/artirix_data_models/gateways/data_gateway_spec.rb
 - spec/artirix_data_models/gateways/gateway_response_adaptors/model_adaptor_spec.rb
 - spec/artirix_data_models/model_fields_dao_spec.rb
+- spec/artirix_data_models/model_spec.rb
 - spec/fixtures/articles_search_dl.json
 - spec/fixtures/articles_search_multiple_nested_raw_es.json
 - spec/fixtures/articles_search_nested_raw_es.json
@@ -315,6 +316,7 @@ test_files:
 - spec/artirix_data_models/gateways/data_gateway_spec.rb
 - spec/artirix_data_models/gateways/gateway_response_adaptors/model_adaptor_spec.rb
 - spec/artirix_data_models/model_fields_dao_spec.rb
+- spec/artirix_data_models/model_spec.rb
 - spec/fixtures/articles_search_dl.json
 - spec/fixtures/articles_search_multiple_nested_raw_es.json
 - spec/fixtures/articles_search_nested_raw_es.json