u-attributes 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f28992fcd550ab8d700f8d722af72a486c84cdc5cb5d8fd526dd653d0f88ffb9
-  data.tar.gz: 9896e8b25b7abcb11503bd0f11f91ddcb4f0bcfcbbe6a5467928a791da7f8d6f
+  metadata.gz: ddf72936cbd627a8261e6db0b11a200cdb75e94dc502866dca65b36817d42d32
+  data.tar.gz: 2c6c8f8a5343dd21ccea4dbab2ce44e75d0ea7d3012d862b75f24cd27edaed08
 SHA512:
-  metadata.gz: a77934dec03187c8b45ff2c9e1577472dc7b2a7633cae3edec6c2a9d093acb35262f10e625ffb8ac086d949f41f8a0b1d46f1e57df585b03d0f9b51b72a2ff53
-  data.tar.gz: bd186e19af413b6bf26943fe4b527f285725b947226a65bc11ac35b5909883515e09267a11bbbe812e941d3aebb586c4535d406d0f7c2f6079fa42f1346ea82d
+  metadata.gz: 1285076cd8133141b1d711c31bd334e27bca6e1d9942d20e26e390db8b9c646d47b327b3e3107e6e71fc97012d3b8c63c830c6f9fce7d04c0b823efb8da6e00e
+  data.tar.gz: 0c529556494c63cec393199f74492b0a8a75be8fe48d61abbb4b4c35964e7d68621bcf6b42e09a367bbd6db3cb9ca01006f56399e8e5e1e7ad48ea842b69b977

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    u-attributes (0.5.0)
+    u-attributes (0.6.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,4 +1,4 @@
-# Micro::Attributes
+# μ-attributes (Micro::Attributes)
 
 This gem allows defining read-only attributes, that is, your objects will have only getters to access their attributes data.
 
@@ -7,7 +7,7 @@ This gem allows defining read-only attributes, that is, your objects will have o
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'micro-attributes'
+gem 'u-attributes'
 ```
 
 And then execute:
@@ -16,7 +16,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install micro-attributes
+    $ gem install u-attributes
 
 ## Usage
 
@@ -59,9 +59,9 @@ puts person.age  # 21
 # person.name = 'Rodrigo'
 # NoMethodError (undefined method `name=' for #<Person:0x0000... @name="John Doe", @age=21>)
 
-####################
+#------------------#
 # self.attributes= #
-####################
+#------------------#
 
 # This protected method is added to make easier the assignment in a constructor.
 
@@ -126,13 +126,22 @@ puts person.age  # 18
 # Assigning new values to get a new instance #
 ##############################################
 
+#-------------------#
+# #with_attribute() #
+#-------------------#
+
 another_person = person.with_attribute(:age, 21)
 
 puts another_person.name           # John Doe
 puts another_person.age            # 21
 puts another_person.equal?(person) # false
 
-# Use #with_attributes to assign multiple attributes
+#--------------------#
+# #with_attributes() #
+#--------------------#
+#
+# Use it to assign multiple attributes
+
 other_person = person.with_attributes(name: 'Serradura', age: 32)
 
 puts other_person.name           # Serradura
@@ -157,6 +166,77 @@ instance = Subclass.new({})
 puts instance.name              # John Doe
 puts instance.respond_to?(:age) # true
 puts instance.respond_to?(:foo) # true
+
+##############################################################
+# Inheritance allows to redefine the attributes default data #
+##############################################################
+
+class AnotherSubclass < Person
+  attribute! name: 'Alfa'
+end
+
+alfa_person = AnotherSubclass.new({})
+
+p alfa_person.name # "Alfa"
+p alfa_person.age  # nil
+
+class SubSubclass < Subclass
+  attributes! name: 'Beta', age: 0
+end
+
+beta_person = SubSubclass.new({})
+
+p beta_person.name # "Beta"
+p beta_person.age  # 0
+```
+
+### How to query the attributes?
+
+```ruby
+class Person
+  include Micro::Attributes
+
+  attributes :age, name: 'John Doe'
+
+  def initialize(options)
+    self.attributes = options
+  end
+end
+
+#---------------#
+# .attributes() #
+#---------------#
+
+p Person.attributes # ["name", "age"]
+
+#---------------#
+# .attribute?() #
+#---------------#
+
+puts Person.attribute?(:name)  # true
+puts Person.attribute?('name') # true
+puts Person.attribute?('foo') # false
+puts Person.attribute?(:foo)  # false
+
+# ---
+
+person = Person.new(age: 20)
+
+#---------------#
+# #attribute?() #
+#---------------#
+
+puts person.attribute?(:name)  # true
+puts person.attribute?('name') # true
+puts person.attribute?('foo') # false
+puts person.attribute?(:foo)  # false
+
+#---------------#
+# #attributes() #
+#---------------#
+
+p person.attributes                   # {"age"=>20, "name"=>"John Doe"}
+p Person.new(name: 'John').attributes # {"age"=>nil, "name"=>"John"}
 ```
 
 ## Development

data/lib/micro/attributes/macros.rb

@@ -24,14 +24,22 @@ module Micro
         @__attributes_data ||= {}
       end
 
-      def __attribute_data(name, value)
-        __attributes_data[name] = value if __attribute(name)
+      def __attribute_data(name, value, allow_to_override)
+        __attributes_data[name] = value if allow_to_override || __attribute(name)
+      end
+
+      def __attribute_data!(arg, allow_to_override:)
+        return __attribute_data(arg.to_s, nil, allow_to_override) unless arg.is_a?(Hash)
+
+        arg.each { |key, value| __attribute_data(key.to_s, value, allow_to_override) }
       end
 
       def attribute(arg)
-        return __attribute_data(arg.to_s, nil) unless arg.is_a?(Hash)
+        __attribute_data!(arg, allow_to_override: false)
+      end
 
-        arg.each { |key, value| __attribute_data(key.to_s, value) }
+      def attribute!(arg)
+        __attribute_data!(arg, allow_to_override: true)
       end
 
       def attributes(*args)
@@ -40,6 +48,10 @@ module Micro
         args.flatten.each { |arg| attribute(arg) }
       end
 
+      def attributes!(*args)
+        args.flatten.each { |arg| attribute!(arg) }
+      end
+
       def attributes_data(arg)
         __attributes_data.merge(
           Utils.hash_argument!(arg)

data/lib/micro/attributes/version.rb

@@ -2,6 +2,6 @@
 
 module Micro
   module Attributes
-    VERSION = "0.5.0"
+    VERSION = "0.6.0"
   end
 end

data/lib/micro/attributes.rb

@@ -13,6 +13,7 @@ module Micro
         private_class_method :__attribute
         private_class_method :__attributes
         private_class_method :__attribute_data
+        private_class_method :__attribute_data!
         private_class_method :__attributes_data
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: u-attributes
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Rodrigo Serradura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-04 00:00:00.000000000 Z
+date: 2019-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Define read-only attributes