activerecord-utils 0.0.1 → 0.1.0

data/README.md

@@ -2,3 +2,65 @@
 
 activerecord-utils gem - utilities (e.g. random, alias_attr, etc.) for activerecord in ruby
 
+* home  :: [github.com/rubylibs/activerecord-utils](https://github.com/rubylibs/activerecord-utils)
+* bugs  :: [github.com/rubylibs/activerecord-utils/issues](https://github.com/rubylibs/activerecord-utils/issues)
+* gem   :: [rubygems.org/gems/activerecord-utils](https://rubygems.org/gems/activerecord-utils)
+* rdoc  :: [rubydoc.info/gems/activerecord-utils](http://rubydoc.info/gems/activerecord-utils)
+
+## Usage
+
+### `alias_attr` macro
+
+
+    alias_attr  :plato, :og         # new, old
+
+generates
+
+    def plato                 # reader
+      send( :og )             #  e.g. return og
+    end
+    
+    def plato=(value)         # writer
+      send( :'og=', value )   #  e.g. return self.og=value
+    end
+
+
+### `attr_reader_w_fallback` macro
+
+    attr_reader_w_fallbacks :published, :touched
+
+generates
+
+    def published
+      read_attribute_w_fallbacks( :published, :touched )
+    end
+
+
+### 'rnd' finder
+
+e.g. find random record e.g.
+
+
+    beer_of_the_week = Beer.rnd
+
+equals
+
+    beer_of_the_week = Beer.offset( rand( Beer.count) ).limit(1).first
+
+
+
+## Alternatives
+
+### Random
+
+- [`random_record` gem](http://rubygems.org/gems/random_record) - [(Source)](https://github.com/rahult/random_record) returns a random record for Ruby Models using ActiveRecord
+- [`activerecord_random` gem](http://rubygems.org/gems/activerecord_random) - [(Source)](https://github.com/GnomesLab/activerecord_random) empowers your ActiveRecord Models with the ability to return a random record without using SQL RAND()
+- [`randomizr` gem](http://rubygems.org/gems/randomizr) - Returns one random Active Record object using cross-platform ANSI compliant SQL
+- [`fast_random` gem](http://rubygems.org/gems/fast_random) - [(Source)](https://github.com/xdite/fast_random) ultra fast order by rand() solution 
+- [`randumb`](https://github.com/spilliton/randumb) - adds ability to pull back random records from Active Record
+
+
+## License
+
+The scripts are dedicated to the public domain.
+Use it as you please with no restrictions whatsoever.

data/lib/activerecord/utils.rb

@@ -1,9 +1,10 @@
 
 
-require 'activerecord/utils/version'  # let it always go first
+require 'activerecord/utils/version'  # let version always go first
 
 
 module ActiveRecord
+
 module Utils
 
   def self.banner
@@ -15,10 +16,109 @@ module Utils
     "#{File.expand_path( File.dirname(File.dirname(__FILE__)) )}"
   end
 =end
-
 end  # module Utils
+
 end  # module ActiveRecord
 
 
+########################
+# add some methods to ActiveRecord::Base
+#
+#  - todo: use Concerns ?? why? why not??
+
+
+class ActiveRecord::Base
+  
+  ### note:
+  ## alias_method will NOT work for activerecord attributes
+  ##  - attribute reader/writer will NOT exist on startup
+  #  thus, lets add a new alias_attr that will
+  #    send message / forward  method call on demand
+  #
+  # e.g. use like:
+  #
+  #   alias_attr  :abvii, :abv
+
+  ##
+  # todo: add opts={} e.g. lets us add, for example, depreciated: true  ??
+  #  - will issue a warning 
+
+  def self.alias_attr_reader( new, old )
+    define_method( new ) do
+      send( old )
+      ### use read_attribute( old ) instead? why? why not??
+      #  see http://www.davidverhasselt.com/2011/06/28/5-ways-to-set-attributes-in-activerecord/
+    end
+    ## todo: check for boolean values - add new? version too ??
+  end
+
+  def self.alias_attr_writer( new, old )
+    define_method( "#{new}=" ) do |value|
+      send( "#{old}=", value )
+    end
+  end
+  
+  def self.alias_attr( new, old )
+    alias_attr_reader( new, old )
+    alias_attr_writer( new, old )
+  end
+
+  ###################
+  #
+  #
+  # e.g. use like:
+  #
+  # def published
+  #  read_attribute_w_fallbacks( :published, :touched )
+  # end
+  #
+  # or use macro e.g.
+  #
+  #  attr_reader_w_fallbacks :published, :touched
+
+
+  def self.attr_reader_w_fallbacks( *keys )
+    define_method( keys[0] ) do
+      read_attribute_w_fallbacks( keys )
+    end
+  end
+
+  def read_attribute_w_fallbacks( *keys )
+    ### todo: use a different name e.g.:
+    ## read_attribute_cascade ?? - does anything like this exists already?
+    ## why? why not?
+    keys.each do |key|
+      value = read_attribute( key )
+      return value unless value.nil?
+    end
+    value # fallthrough? return latest value (will be nil) --or return just nil - why? why not??
+  end
+
+
+  ###############
+  # random
+  #
+  #
+  #  e.g. use like:
+  #
+  #   beer_of_the_week = Beer.rnd
+  
+
+  def self.rnd
+    ## works w/ sqlite3 and postgresql
+    ##  - check if it works w/ mysql/mariadb too ? suppots offset and limit in SQL?
+
+    ## todo: use ::rand  -- and lets add an self.rand alias too ??
+    ##  check if ::rand call works
+    rnd_offset = rand( self.count ) ## NB: call "global" std lib rand
+
+    self.offset( rnd_offset ).limit( 1 ).first
+  end
+
+
+end # class ActiveRecord::Base
+
+
+
 puts ActiveRecord::Utils.banner    # say hello
 

data/lib/activerecord/utils/version.rb

@@ -2,7 +2,7 @@
 module ActiveRecord
 
 module Utils
-   VERSION = '0.0.1'
+   VERSION = '0.1.0'
 end
 
 end # module ActiveRecord

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-utils
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-22 00:00:00.000000000 Z
+date: 2013-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &78028610 !ruby/object:Gem::Requirement
+  requirement: &71207220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3.10'
   type: :development
   prerelease: false
-  version_requirements: *78028610
+  version_requirements: *71207220
 - !ruby/object:Gem::Dependency
   name: hoe
-  requirement: &78028350 !ruby/object:Gem::Requirement
+  requirement: &71206890 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +32,7 @@ dependencies:
         version: '3.3'
   type: :development
   prerelease: false
-  version_requirements: *78028350
+  version_requirements: *71206890
 description: activerecord-utils - utilities (e.g. random, alias_attr, etc.) for activerecord
 email: webslideshow@googlegroups.com
 executables: []