u-attributes 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 6c1299b85819a1443c0bfbd3d64afcb4ab902e0ed7664df011f19cf9e4849d1d
-  data.tar.gz: 181160fdc96e1d4fe21ea5b84aedd0dac595cb2345db515096bb5ce02a932ce6
+SHA1:
+  metadata.gz: 4ffcf4806ec9d80d37275acd60cae7b17e631eb1
+  data.tar.gz: 097f3021f4926e30f1fae6f013546e720cdde813
 SHA512:
-  metadata.gz: 97c6d8ab9ada8548382aebea4f396c2b32d7769fa583ee4476cd974e02b6623ebbad5fb5fed18d6960875f52f36165146b00696a4f763b6c199a5b8c948e59b9
-  data.tar.gz: 3749512fc8eee2a6508d9901205a9655dfad0b503db81b18eb52c70fecbf0f24c16a2d82c3639daaa67f90816ee057457d99a950dc7ed7d5a070009df1030712
+  metadata.gz: 13d1ef7f388acad2924444ffc0895efe77f4dda23cbbe7bccb1043fb438bc5489d2da02b9497f79f5e60a0d9c6734a1df53e34be7411eaeebde66fbd94168d78
+  data.tar.gz: 18adb33e86569aa4f0a0b6bb0c0f390bab59b895d71c79076f2e6ba158f1733b0f8df64a2926a34fe90deed491150fbe2f3553761593a70eebe4a32715505d33

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    u-attributes (0.1.0)
+    u-attributes (0.3.0)
 
 GEM
   remote: https://rubygems.org/
@@ -20,11 +20,10 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 2.0)
   minitest (~> 5.0)
   rake (~> 10.0)
   simplecov
   u-attributes!
 
 BUNDLED WITH
-   2.0.1
+   1.17.3

data/README.md

@@ -1,8 +1,6 @@
 # Micro::Attributes
 
-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/micro/attributes`. 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 allows defining read-only attributes, that is, your objects will have only getters to access their attributes data.
 
 ## Installation
 
@@ -22,7 +20,121 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### How to require?
+```ruby
+# Bundler will do it automatically, but if you desire to do a manual require.
+# Use one of the following options:
+
+require 'micro/attributes'
+
+# or
+
+require 'u-attributes'
+```
+
+### How to define attributes?
+```ruby
+
+# By default you must to define the class constructor.
+
+class Person
+  include Micro::Attributes
+
+  attribute :name
+  attribute :age
+
+  def initialize(name: 'John Doe', age:)
+    @name, @age = name, age
+  end
+end
+
+person = Person.new(age: 21)
+
+puts person.name # John Doe
+puts person.age  # 21
+
+# By design, the attributes expose only reader methods (getters).
+# If you try to call a setter, you will see a NoMethodError.
+#
+# person.name = 'Rodrigo'
+# NoMethodError (undefined method `name=' for #<Person:0x0000... @name="John Doe", @age=21>)
+```
+
+### How to define multiple attributes?
+
+```ruby
+
+# Use .attributes with a list of attribute names.
+
+class Person
+  include Micro::Attributes
+
+  attributes :name, :age
+
+  def initialize(name, age)
+    @name, @age = name, age
+  end
+end
+
+person = Person.new('Serradura', 32)
+
+puts person.name # Serradura
+puts person.age  # 32
+```
+
+### How to define attributes with a constructor to assign them?
+A: Use `Micro::Attributes.to_initialize`
+
+```ruby
+class Person
+  include Micro::Attributes.to_initialize
+
+  attributes :age, name: 'John Doe' # Use a hash to define a default value
+
+  # attribute name: 'John Doe'
+  # attribute :age
+end
+
+person = Person.new(age: 18)
+
+puts person.name # John Doe
+puts person.age  # 18
+
+##############################################
+# Assigning new values to get a new instance #
+##############################################
+
+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
+other_person = person.with_attributes(name: 'Serradura', age: 32)
+
+puts other_person.name           # Serradura
+puts other_person.age            # 32
+puts other_person.equal?(person) # false
+
+# If you pass a value different of a Hash, an ArgumentError will be raised.
+#
+# Person.new(1)
+# ArgumentError (argument must be a Hash)
+
+#########################################################
+# Inheritance will preserve the parent class attributes #
+#########################################################
+class Subclass < Person
+  attribute :foo
+end
+
+instance = Subclass.new({})
+
+puts instance.name              # John Doe
+puts instance.respond_to?(:age) # true
+puts instance.respond_to?(:foo) # true
+```
 
 ## Development
 

data/lib/micro/attributes/macros.rb

@@ -49,7 +49,7 @@ module Micro
           undefineds.each_with_object({}) { |name, memo| memo[name] = nil }
 
         yield(
-          normalized_params.merge!(nil_params).merge!(__attributes_defaults)
+          nil_params.merge!(__attributes_defaults).merge!(normalized_params)
         )
       end
     end

data/lib/micro/attributes/version.rb

@@ -2,6 +2,6 @@
 
 module Micro
   module Attributes
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

data/lib/micro/attributes.rb

@@ -32,9 +32,18 @@ module Micro
           base.send(:include, Micro::Attributes)
 
           base.class_eval(<<-RUBY)
-            def initialize(params); self.attributes = params; end
-            def with_attribute(key, val); self.class.new(attributes.merge(key => val)); end
-            def with_attributes(params); self.class.new(attributes.merge(params)); end
+            def initialize(arg)
+              raise ArgumentError, 'argument must be a Hash' unless arg.is_a?(Hash)
+              self.attributes = arg
+            end
+
+            def with_attribute(key, val)
+              self.class.new(attributes.merge(key => val))
+            end
+
+            def with_attributes(arg)
+              self.class.new(attributes.merge(arg))
+            end
           RUBY
         end
       end

data/micro-attributes.gemspec

@@ -10,6 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["rodrigo.serradura@gmail.com"]
 
   spec.summary       = %q{Define read-only attributes}
+  spec.description   = %q{This gem allows defining read-only attributes, that is, your objects will have only getters to access their attributes data.}
   spec.homepage      = "https://github.com/serradura/u-attributes"
   spec.license       = "MIT"
 
@@ -22,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.required_ruby_version = '>= 2.2.0'
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: u-attributes
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Rodrigo Serradura
@@ -10,20 +10,6 @@ bindir: exe
 cert_chain: []
 date: 2019-07-03 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,7 +38,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-description: 
+description: This gem allows defining read-only attributes, that is, your objects
+  will have only getters to access their attributes data.
 email:
 - rodrigo.serradura@gmail.com
 executables: []
@@ -86,14 +73,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Define read-only attributes