activerecord-utils 0.1.0 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eecd95d124a2fccb441fb7dfeafc2d5dc87c3679
+  data.tar.gz: ce9c1533eb2bd30b81bc0ba41b31fb4223c15bb3
+SHA512:
+  metadata.gz: b3f887f9f2709b50bafe9b8ed500be5fece830ad71355f4c7e7d9baacaa41d1d10d42aca019b2be98f00b26445fb50f74d031ebc336928e561f57fa630cd9ec7
+  data.tar.gz: f036fddcc6990e7932b15d9ccbb29168214d58a12b6b5080e0e908cb084ca6d46f395fcd2f8b9f2d6f95f9f968108c7438ae9c025c2170149961955a92fa17b8

data/Manifest.txt

@@ -3,4 +3,10 @@ Manifest.txt
 README.md
 Rakefile
 lib/activerecord/utils.rb
+lib/activerecord/utils/alias.rb
+lib/activerecord/utils/comp3.rb
+lib/activerecord/utils/random.rb
 lib/activerecord/utils/version.rb
+test/helper.rb
+test/test_finders.rb
+test/test_random.rb

data/README.md

@@ -19,7 +19,7 @@ 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
@@ -32,20 +32,23 @@ generates
 generates
 
     def published
-      read_attribute_w_fallbacks( :published, :touched )
+      #  e.g. read_attribute_w_fallbacks( :published, :touched ) - equals:
+      
+      value = read_attribute( :published )
+      value = read_attribute( :touched )   if value.nil?
+      value 
     end
 
 
-### 'rnd' finder
-
-e.g. find random record e.g.
+### `rnd` finder
 
+Find random record e.g.:
 
     beer_of_the_week = Beer.rnd
 
 equals
 
-    beer_of_the_week = Beer.offset( rand( Beer.count) ).limit(1).first
+    beer_of_the_week = Beer.offset( rand( Beer.count ) ).limit(1).first
 
 
 
@@ -63,4 +66,4 @@ equals
 ## License
 
 The scripts are dedicated to the public domain.
-Use it as you please with no restrictions whatsoever.
+Use it as you please with no restrictions whatsoever.

data/Rakefile

@@ -18,13 +18,13 @@ Hoe.spec 'activerecord-utils' do
   self.history_file = 'History.md'
 
   self.extra_deps = [
-    ### ['logutils', '>= 0.5']
+    ['logutils']
   ]
 
   self.licenses = ['Public Domain']
 
   self.spec_extras = {
-   :required_ruby_version => '>= 1.9.2'
+   required_ruby_version: '>= 1.9.2'
   }
 
 

data/lib/activerecord/utils.rb

@@ -1,5 +1,4 @@
 
-
 require 'activerecord/utils/version'  # let version always go first
 
 
@@ -8,14 +7,15 @@ module ActiveRecord
 module Utils
 
   def self.banner
-    "activerecord-utils #{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
+    ## add ar PRE too? how?
+    ar = "activerecord/#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}.#{ActiveRecord::VERSION::TINY}"
+    "activerecord-utils/#{VERSION} (#{ar}) on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
   end
 
-=begin
   def self.root
-    "#{File.expand_path( File.dirname(File.dirname(__FILE__)) )}"
+    "#{File.expand_path( File.dirname(File.dirname(File.dirname(__FILE__))) )}"
   end
-=end
+
 end  # module Utils
 
 end  # module ActiveRecord
@@ -23,102 +23,17 @@ end  # module ActiveRecord
 
 ########################
 # add some methods to ActiveRecord::Base
-#
 #  - todo: use Concerns ?? why? why not??
 
+if ActiveRecord::VERSION::MAJOR == 3   # only add to 3.x series
+  require 'activerecord/utils/comp3'
+end
 
-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
-
+require 'activerecord/utils/alias'
+require 'activerecord/utils/random'
 
 
 puts ActiveRecord::Utils.banner    # say hello
 
+### puts "root: >#{ActiveRecord::Utils.root}<"   # check root path (remove later)
+

data/lib/activerecord/utils/alias.rb

@@ -0,0 +1,71 @@
+
+module ActiveRecord
+class 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 )
+      break unless value.nil?  # if value.nil? == false
+    end
+    value # fallthrough -- return latest value (will be nil)
+  end
+
+end # class Base
+end # module ActiveRecord

data/lib/activerecord/utils/comp3.rb

@@ -0,0 +1,21 @@
+# encoding: UTF-8
+
+module ActiveRecord
+class Base
+
+    ###
+    # todo/fix:
+    #  better check if responds_to? find_by! and find_by ???
+    puts "  [ActiveRecord::Utils] adding find_by n find_by! finders for 3.x series"
+
+    ## lets us use ActiveRecord 4-style find_by and find_by! in ActiveRecord 3.x  
+    def self.find_by( hash )
+      self.where( hash ).first
+    end
+    
+    def self.find_by!( hash )
+      self.where( hash ).first!     ## or use: first or raise RecordNotFound  directly??
+    end
+
+end # class Base
+end # module ActiveRecord

data/lib/activerecord/utils/random.rb

@@ -0,0 +1,27 @@
+# encoding: UTF-8
+
+module ActiveRecord
+class Base
+  
+  ###############
+  # 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 Base
+end # module ActiveRecord

data/lib/activerecord/utils/version.rb

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

data/test/helper.rb

@@ -0,0 +1,90 @@
+
+## $:.unshift(File.dirname(__FILE__))
+
+## minitest setup
+
+# require 'minitest/unit'
+require 'minitest/autorun'
+
+# include MiniTest::Unit  # lets us use TestCase instead of MiniTest::Unit::TestCase
+
+
+# ruby stdlibs
+
+require 'json'
+require 'uri'
+require 'pp'
+require 'logger'
+
+# ruby gems
+
+require 'active_record'
+
+require 'logutils'
+require 'logutils/db'   # NB: explict require required for LogDb (not automatic) 
+
+
+# our own code
+
+require 'activerecord/utils'
+
+
+class Beer < ActiveRecord::Base
+  alias_attr :abvii, :abv
+  alias_attr_reader :abvread, :abv
+  alias_attr_writer :abvwrite, :abv
+end
+
+
+
+class CreateBeerDb
+  
+  def up
+    ActiveRecord::Schema.define do
+
+    create_table :beers do |t|
+      t.string  :key,   null: false
+      t.string  :name,  null: false
+
+      t.string  :web    # optional url link (e.g. )
+      t.integer :since  # optional year (e.g. 1896)
+
+      t.decimal    :abv    # Alcohol by volume (abbreviated as ABV, abv, or alc/vol) e.g. 4.9 %
+      t.decimal    :og     # malt extract (original gravity) in plato
+
+      t.timestamps
+    end 
+    end # Schema.define
+  end # method up
+
+end  # class CreateMovieDb
+
+
+
+def setup_in_memory_db
+  # Database Setup & Config
+
+  db_config = {
+    adapter:  'sqlite3',
+    database: ':memory:'
+  }
+
+  pp db_config
+
+  ActiveRecord::Base.logger = Logger.new( STDOUT )
+  ## ActiveRecord::Base.colorize_logging = false  - no longer exists - check new api/config setting?
+
+  ## NB: every connect will create a new empty in memory db
+  ActiveRecord::Base.establish_connection( db_config )
+
+
+  ## build schema
+  LogDb.create
+  CreateBeerDb.new.up
+  
+  Beer.create!( key: 'ottakringerhelles', name: 'Ottakringer Helles' )
+  Beer.create!( key: 'ottakringerzwicklrot', name: 'Ottakringer Zwickl Rot' )
+end
+
+
+setup_in_memory_db()

data/test/test_finders.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+require 'helper'
+
+class TestFinders < MiniTest::Unit::TestCase
+
+
+  def test_find_by
+    b = Beer.find_by( key: 'ottakringerhelles' )
+    assert_equal 'Ottakringer Helles', b.name
+    
+    b = Beer.find_by( key: 'zwettlerdunkles' )
+    assert_equal nil, b
+    
+    b = Beer.find_by!( key: 'ottakringerhelles' )
+    assert_equal 'Ottakringer Helles', b.name
+
+    ## fix/todo: add
+    ## raises RecordNotfound 
+    ## b = Beer.find_by!( key: 'zwettlerdunkles' )
+  end
+
+end # class TestFinders
+

data/test/test_random.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+require 'helper'
+
+class TestRandom < MiniTest::Unit::TestCase
+
+  def test_rnd
+    b = Beer.rnd
+    assert_equal false, b.name.blank?
+    assert_equal false, b.key.blank?
+
+    ## try another
+    b = Beer.rnd
+    assert_equal false, b.name.blank?
+    assert_equal false, b.key.blank?
+  end
+
+end # class TestRandom

metadata

@@ -1,54 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-utils
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-24 00:00:00.000000000 Z
+date: 2014-04-15 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: logutils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &71207220 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '4.0'
   type: :development
   prerelease: false
-  version_requirements: *71207220
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: hoe
-  requirement: &71206890 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.10'
   type: :development
   prerelease: false
-  version_requirements: *71206890
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.10'
 description: activerecord-utils - utilities (e.g. random, alias_attr, etc.) for activerecord
 email: webslideshow@googlegroups.com
 executables: []
 extensions: []
 extra_rdoc_files:
+- History.md
 - Manifest.txt
+- README.md
 files:
 - History.md
 - Manifest.txt
 - README.md
 - Rakefile
 - lib/activerecord/utils.rb
+- lib/activerecord/utils/alias.rb
+- lib/activerecord/utils/comp3.rb
+- lib/activerecord/utils/random.rb
 - lib/activerecord/utils/version.rb
+- test/helper.rb
+- test/test_finders.rb
+- test/test_random.rb
+- .gemtest
 homepage: https://github.com/rubylibs/activerecord-utils
 licenses:
 - Public Domain
+metadata: {}
 post_install_message: 
 rdoc_options:
 - --main
@@ -56,21 +85,21 @@ rdoc_options:
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: activerecord-utils
-rubygems_version: 1.8.17
+rubyforge_project: 
+rubygems_version: 2.1.10
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: activerecord-utils - utilities (e.g. random, alias_attr, etc.) for activerecord
-test_files: []
+test_files:
+- test/test_finders.rb
+- test/test_random.rb