lazy_record 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1dd02d425756e1e782fb8ddb8200ebd979d8b46d
-  data.tar.gz: 8033557b1ed171bacc267b69402f59122f496ee6
+  metadata.gz: ecdcea0a9c3288387372a9251debe33d83372906
+  data.tar.gz: a0fd6848c4ab36434e5ecb4c88dac81f851bb708
 SHA512:
-  metadata.gz: 5e9680e081c05fef1268a6b6ec662634bce7ba75eff2d5db8518bbe9eaa36152b28f4bb66fffa44ab03d11897f35ada16d1abf59377a58fd72ddfdb50a32fb85
-  data.tar.gz: 2de4c3dd15b30c3540e1f01142c5c03155af15720ecd83aa4ee828e8228c567c3b19903e94611d9e4e8d18f02efb32b89eb88ed5d622caae6d62a7d07b6de32f
+  metadata.gz: aa77719da043990d92bd9dc2aaf5dbef32f125dedac67247cc385f68ee846121a6206fe067d07d335c0f465967f04024e3a3486a067b565ed7f521f57375c71d
+  data.tar.gz: f64d912e5021fb72ad64e0370ae7edae5c60e42ef17582953ca27c65e718b3383c75962b357cc08f79a5e64cc614d23710bf1bff0b97e82e7527b343008faa13

data/README.md

@@ -45,24 +45,50 @@ thing = Thing.new { |t| puts t.class.superclass }
 ```
 Every LazyRecord object is assigned an auto-incrementing ID after initialization. IDs reset when the program is terminated.
 
-Use `lr_attr_accessor` like you would use `attr_accessor`. You'll get hash syntax in your `#intialize` method for attribute setting.
+Use `attr_accessor` like you would use normally, and you'll get hash syntax in your `#intialize` method for attribute setting. The attributes will also be visible when the object is returned or `inspected`. Attributes defined with `attr_reader` will also be visible, but `attr_writers`, custom getters and writers, and other methods will not.
 
 ```ruby
 class Thing < LazyRecord::Base
-  lr_attr_accessor :stuff, :junk
+  attr_accessor :stuff, :junk
+  attr_reader :hmm
+  
+  def something
+    @something ||= 'something'
+  end
 end
 
 thing = Thing.new stuff: 'stuff' do |t|
   t.junk = 'junk'
 end
-# => #<Thing id: 1, stuff: "stuff", junk: "junk">
+# => #<Thing id: 1, stuff: "stuff", junk: "junk", hmm: nil>
+thing.something
+# => "something"
+```
+If you want to define private or protected `attr_accessor`s or `attr_reader`s, they will not be visible when inspecting the object, and you should do so like the following example.
+```ruby
+class Thing < LazyRecord::Base
+  attr_accessor :stuff, :junk
+  private :junk, :junk= # passing the setter and getter method names as arguments to Module.private/Module.protected will work
+  
+  private_attr_accessor :hmm # this also works
+  protected_attr_accessor :huh # this works too
+  
+  private
+  attr_accessor :what # declaring the methods after calling the private method will not work, and the methods will be public and visible.
+                      # this is a bug due to the custom implementation of .attr_*, and if anyone can find a fix please submit it!
+                      # otherwise, the other two forms work just fine.
+                      # and really, who wants to declare private attr_accessors this way anyway :-P ?
+end
 ```
+Earlier implementations used a custom `lr_attr_accessor` method, however this has been deprecated in favor of overriding `attr_*` so the methods will be parsed by RDoc.
+
+See @dbrady's `scoped_attr_accessor` gem for more info on the `scoped_attr_*` methods.
 
 Validate presence of attributes with `lr_validates` like you would with ActiveRecord. Failed validations will return false and the ID will not be incremented. More validation options coming in the future.
 
 ```ruby
 class Thing < LazyRecord::Base
-  lr_attr_accessor :stuff, :junk
+  attr_accessor :stuff, :junk
   lr_validates :stuff, presence: true
 end
 
@@ -79,7 +105,7 @@ class Whatever < LazyRecord::Base
 end
 
 class Thing < LazyRecord::Base
-  lr_attr_accessor :stuff, :junk
+  attr_accessor :stuff, :junk
   lr_validates :stuff, presence: true
   lr_has_many :whatevers
 end
@@ -101,7 +127,7 @@ Use `lr_scope` and `#where` to create class scope methods and query objects. Wor
 
 ```ruby
 class Whatever < LazyRecord::Base
-  lr_attr_accessor :party_value, :sleepy_value
+  attr_accessor :party_value, :sleepy_value
   lr_scope :big_party, -> { where('party_value > 10') }
   lr_scope :low_sleepy, -> { where('sleepy_value < 10') }
 end
@@ -158,13 +184,13 @@ Use `lr_method` for an alternative API for defining short instance methods. Can
 
 ```ruby
 class Whatever < LazyRecord::Base
-  lr_attr_accessor :party_value, :sleepy_value, :right
+  attr_accessor :party_value, :sleepy_value, :right
   lr_scope :big_party, -> { where('party_value > 10') }
   lr_scope :low_sleepy, -> { where('sleepy_value < 10') }
 end
 
 class Thing < LazyRecord::Base
-  lr_attr_accessor :stuff, :junk
+  attr_accessor :stuff, :junk
   lr_validates :stuff, presence: true
   lr_has_many :whatevers
   lr_method :speak, -> (string) { puts string }

data/lazy_record.gemspec

@@ -16,8 +16,6 @@ Gem::Specification.new do |spec|
   spec.license       = 'MIT'
   spec.required_ruby_version = '>= 2.1.0'
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)
     spec.metadata['allowed_push_host'] = 'https://rubygems.org'
   else
@@ -32,7 +30,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency             'activesupport'
+  spec.add_dependency 'activesupport', '~> 5.0'
+  spec.add_dependency 'scoped_attr_accessor', '~> 1.0', '>= 1.0.3'
 
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rspec'

data/lib/lazy_record.rb

@@ -2,6 +2,8 @@
 
 require 'active_support'
 require 'active_support/inflector'
+require 'scoped_attr_accessor'
+
 require 'lazy_record/version'
 require 'lazy_record/associations'
 require 'lazy_record/attributes'

data/lib/lazy_record/associations.rb

@@ -92,18 +92,18 @@ module LazyRecord
     end
 
     def define_has_one_associations_to_s
-      define_method(:has_one_associations_to_s) do
+      define_method(:associations_to_s) do
         associations.map do |association|
           "#{association}: #{stringify_value(send(association))}"
         end
       end
-      private :has_one_associations_to_s
+      private :associations_to_s
     end
 
-    def define_association_setter(association)
-      model = find_scoped_association_class(association)
-      define_method("#{association}=") do |assoc|
-        return instance_variable_set("@#{association}", assoc) if assoc.is_a? model.call
+    def define_association_setter(assoc)
+      model = find_scoped_association_class(assoc)
+      define_method("#{assoc}=") do |value|
+        return instance_variable_set("@#{assoc}", value) if value.is_a? model.call
         raise ArgumentError, "Argument must be a #{model.call}"
       end
     end

data/lib/lazy_record/attributes.rb

@@ -7,42 +7,28 @@ module LazyRecord
   # yields self to a block. If you want to add custom functionality to
   # #initialize just call super.
   module Attributes
-    ATTR_MODULE_NAME = :DynamicAttributes
-
-    def define_setters_and_getters(name)
-      define_method(name) do
-        instance_variable_get('@' + name.to_s)
-      end
-
-      define_method("#{name}=") do |val|
-        instance_variable_set('@' + name.to_s, val)
-      end
+    def lr_attr_accessor(*names) # TODO: remove in version 1.0.0
+      puts 'Using `.lr_attr_accessor` is deprecated. Use the standard `.attr_*`'\
+      ' methods instead. You will get the same results, plus the methods will be'\
+      ' recognized by rdoc. `.lr_attr_accessor` will be removed in version 1.0.0'
+      attr_accessor(*names)
     end
 
-    def define_instance_attrs_to_s
-      define_method(:instance_attrs_to_s) do
-        instance_attr_accessors.map do |attr|
-          value = send(attr)
-          "#{attr}: #{stringify_value(value)}"
-        end
-      end
-      private :instance_attrs_to_s
+    undef_method(:lr_attr_accessor) if LazyRecord::VERSION >= '1.0.0'
+
+    def attr_accessor(*names)
+      super(*names)
+      add_to_attr_readers(*names)
     end
 
-    def define_instance_attr_accessors(*names)
-      define_method(:instance_attr_accessors) do
-        names.map(&:to_sym)
-      end
-      private :instance_attr_accessors
+    def attr_reader(*names)
+      super(*names)
+      add_to_attr_readers(*names)
     end
 
-    def lr_attr_accessor(*names)
-      include mod = get_or_set_mod(ATTR_MODULE_NAME)
-      mod.extend(Attributes)
-      mod.module_eval do
-        names.each { |name| define_setters_and_getters(name) }
-        define_instance_attr_accessors(*names)
-        define_instance_attrs_to_s
+    def add_to_attr_readers(*names)
+      names.each do |name|
+        attr_readers << name.to_sym
       end
     end
   end

data/lib/lazy_record/base_module.rb

@@ -4,7 +4,9 @@ module LazyRecord
   # This module gives the Base class its functionality, and can be included
   # in any class as an alternative to inheriting from LazyRecord::Base
   module BaseModule
+    # Extend these modules when BaseModule is included
     def self.included(base)
+      base.extend ScopedAttrAccessor
       base.extend ClassMethods
       base.extend Scopes
       base.extend Attributes
@@ -17,34 +19,42 @@ module LazyRecord
 
     attr_writer :id
 
+    # Use options hash to set attributes, and/or operate on object in a block.
+    # Checks each options key for a matching attribute setter method.
     def initialize(opts = {})
-      opts.each do |k, v|
-        send("#{k}=", v) if respond_to?("#{k}=")
+      opts.each do |key, val|
+        send("#{key}=", val) if respond_to?("#{key}=")
       end
       yield self if block_given?
     end
 
-    def instance_attrs_to_s
+    def collection_counts_to_s
       []
     end
 
-    def instance_attr_accessors
-      []
+    def public_attr_readers_to_s
+      @public_attr_readers_to_s ||=
+        self.class.send(:public_attr_readers).map do |attr|
+          value = send(attr)
+          "#{attr}: #{stringify_value(value)}"
+        end
     end
 
-    def collection_counts_to_s
+    def associations_to_s
       []
     end
 
-    def has_one_associations_to_s
-      []
+    def inspect
+      format('#<%s id: %s%s%s%s>',
+             self.class,
+             display_id_even_if_nil,
+             public_attr_readers_to_s.dup.unshift('').join(', '),
+             associations_to_s.unshift('').join(', '),
+             collection_counts_to_s.unshift('').join(', '))
     end
 
-    def inspect
-      "#<#{self.class} id: #{id ? id : 'nil'}"\
-      "#{instance_attrs_to_s.unshift('').join(', ')}"\
-      "#{has_one_associations_to_s.unshift('').join(', ')}"\
-      "#{collection_counts_to_s.unshift('').join(', ')}>"
+    def display_id_even_if_nil
+      id ? id.to_s : 'nil'
     end
 
     def id
@@ -62,13 +72,23 @@ module LazyRecord
     end
 
     private :id=,
+            :display_id_even_if_nil,
             :stringify_value,
-            :instance_attrs_to_s,
-            :instance_attr_accessors,
+            :public_attr_readers_to_s,
             :collection_counts_to_s
 
     # Class methods provided to all LazyRecord classes
     module ClassMethods
+      def public_attr_readers
+        @public_attr_readers ||= attr_readers.reject do |reader|
+          private_method_defined?(reader) || protected_method_defined?(reader)
+        end
+      end
+
+      def attr_readers
+        @attr_readers ||= []
+      end
+
       def all
         @all ||= Relation.new(model: self)
       end

data/lib/lazy_record/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LazyRecord
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,29 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: lazy_record
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - M. Simon Borg
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-10 00:00:00.000000000 Z
+date: 2017-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: scoped_attr_accessor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.3
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement