webget_ruby_rails 1.7.4

data/LICENSE.txt

@@ -0,0 +1,12 @@
+LICENSE
+
+You may choose any of these licenses:
+
+  - CreativeCommons License, Non-commercial Share Alike
+  - LGPL, GNU Lesser General Public License
+  - MIT License
+  - Ruby License
+
+THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.

data/README.rdoc

@@ -0,0 +1,38 @@
+
+= WebGet Ruby Gem: Rails extensions
+
+Author:: Joel Parker Henderson, joelparkerhenderson@gmail.com
+Copyright:: Copyright (c) 2009-2010 Joel Parker Henderson
+License:: CreativeCommons License, Non-commercial Share Alike
+License:: LGPL, GNU Lesser General Public License
+
+Rails extensions are for ActiveRecord, etc. 
+
+Testing: 
+<ul>
+<li>The easy way to run the tests: gem install webget_ruby_rails --test
+<li>Some of the ActiveRecord extensions use sqlite for testing. We don't install sqlite automatically because it requires some native extensions. If you need sqlite: gem install sqlite3-ruby
+</ul>
+
+
+== ActiveRecord
+
+* create_or_update_by: create a record, or update a record if value passed matches a field (or fields) in the AR object; includes method_missing function to make code more readable. 
+* seed: syntactic sugar alias for #create_or_update_by
+
+
+== ActiveRecord::ConnectionAdapters::SchemaStatements
+
+* add_column_and_index: database migration helper to add a table column and index at the same time.
+* remove_column_and_index: database migration helper to add a table column and index at the same time.
+
+
+== ActiveRecord::SaveExtensions
+
+* save_false_then_reload!: a transaction to save and reload a record, to help repair associations
+
+
+== Changes
+
+- 1.0.0 Original 
+

data/lib/webget_ruby_rails.rb

@@ -0,0 +1,45 @@
+=begin rdoc
+
+= WebGet Ruby Gem: Rails extensions
+
+Author:: Joel Parker Henderson, joelparkerhenderson@gmail.com
+Copyright:: Copyright (c) 2009-2010 Joel Parker Henderson
+License:: CreativeCommons License, Non-commercial Share Alike
+License:: LGPL, GNU Lesser General Public License
+
+Rails extensions are for ActiveRecord, etc. 
+
+Testing: 
+<ul>
+<li>The easy way to run the tests: gem install webget_ruby_rails --test
+<li>Some of the ActiveRecord extensions use sqlite for testing. We don't install sqlite automatically because it requires some native extensions. If you need sqlite: gem install sqlite3-ruby
+</ul>
+
+
+== ActiveRecord
+
+* create_or_update_by: create a record, or update a record if value passed matches a field (or fields) in the AR object; includes method_missing function to make code more readable. 
+* seed: syntactic sugar alias for #create_or_update_by
+
+
+== ActiveRecord::ConnectionAdapters::SchemaStatements
+
+* add_column_and_index: database migration helper to add a table column and index at the same time.
+* remove_column_and_index: database migration helper to add a table column and index at the same time.
+
+
+== ActiveRecord::SaveExtensions
+
+* save_false_then_reload!: a transaction to save and reload a record, to help repair associations
+
+
+== Changes
+
+- 1.0.0 Original 
+
+=end
+
+%w{active_record active_record/save_extensions}.map{|x|
+  require File.dirname(__FILE__) + "/webget_ruby_rails/#{x}.rb"
+}
+

data/lib/webget_ruby_rails/active_record.rb

@@ -0,0 +1,119 @@
+require 'activerecord'
+require 'active_record'
+
+#:startdoc:
+# ActiveRecord extensions
+
+module ActiveRecord #:doc:
+
+class Base #:doc:
+
+  # Create a record, or update a record if value passed matches a field in the AR object;
+  # includes method_missing function to make code more readable
+  #
+  # Most common use will be for testing (fixture/mock object generation)
+  #
+  # Three versions of method included:
+  # create_or_update
+  # create_or_update_by
+  # create_or_update_by_xxx (where xxx is a field name)
+  #
+  # Inspired by http://www.intridea.com/2008/2/19/activerecord-base-create_or_update-on-steroids-2
+  #
+  # ==Example
+  # { "admin"     => ["Administrator", 1000], 
+  #   "member"    => ["Member", 1], 
+  #   "moderator" => ["Moderator", 100],
+  #   "disabled"  => ["Disabled User", -1] }.each_pair do |key, val|
+  #     Role.create_or_update_by_key(:key => key, :name => val[0], :value => val[1])
+  # end
+
+  def self.create_or_update(options = {})
+    self.create_or_update_by(:id, options)
+  end
+
+
+  # Create or update a record by field (or fields).
+  # This will look for each field name as a key in the options hash.
+  #
+  # ==Example
+  #   attributes={:name="John Smith", :email=>"john@example.com", :birthdate=>'1980/01/01'}
+  #   User.create_or_update_by(:email,attributes)
+  #   => if a user with that email exists then update his name and birthdate, else create him
+  #
+  # ==Example with multiple conditions
+  #   attributes={:name="John Smith", :email=>"john@example.com", :birthdate=>'1980/01/01'}
+  #   User.create_or_update_by([:name,:birthdate],attributes)
+  #   => if a user with that name and birthdate exists then update his email, else create him
+  #
+  # The fields can be any mix of symbols or strings.
+  # The option keys can be any mix of symbols or strings.
+
+  def self.create_or_update_by(condition_keys, attribute_pairs = {})
+    condition_pairs=[*condition_keys].map{|key| [key,(attribute_pairs.delete(key)||attribute_pairs.delete(key.to_s)||attribute_pairs.delete(key.to_sym))]}.to_h
+    record = find(:first, :conditions => condition_pairs) || self.new
+    if record.new_record? then attribute_pairs.merge!(condition_pairs) end
+    attribute_pairs.each_pair{|key,val| record.send key.to_s+'=', val}
+    record.save!
+    return record
+  end
+
+
+  # Set up a database with initial data, e.g. in rake db:seed method.
+  #
+  # This will look for each field name as a key in the options hash.
+  #
+  # This method calls #create_or_update_by (and you may want to change
+  # this behavior to do more, e.g. to test that a DB and table exists).
+  #
+  # ==Example
+  #   attributes={:name="John Smith", :email=>"john@example.com", :birthdate=>'1980/01/01'}
+  #   User.create_or_update_by(:email,attributes)
+  #   => if a user with that email exists then update his name and birthdate, else create him
+  #
+  # ==Example with multiple conditions
+  #   attributes={:name="John Smith", :email=>"john@example.com", :birthdate=>'1980/01/01'}
+  #   User.create_or_update_by([:name,:birthdate],attributes)
+  #   => if a user with that name and birthdate exists then update his email, else create him
+  #
+  # The fields can be any mix of symbols or strings.
+  # The option keys can be any mix of symbols or strings.
+
+  def self.seed(condition_keys, attribute_pairs = {})
+    self.create_or_update_by(condition_keys, attribute_pairs)
+  end
+
+
+  # Method missing for create_or_update_by_xxx that forwards to #create_or_update_by
+  #
+  # ==Example
+  #   MyModel.create_or_update_by_foo(options)
+  #   => MyModel.create_or_update_by(:foo,option)
+
+  def self.method_missing_with_create_or_update(method_name, *args) 
+    if match = method_name.to_s.match(/create_or_update_by_([a-z0-9_]+)/)  
+      field = match[1]
+      return create_or_update_by(field,*args)
+    end
+    return method_missing_without_create_or_update(method_name, *args)
+  end
+
+
+  # For alias method chain
+  def self.included(base)
+    # base == ActiveRecord::Base (the class)
+    base.class_eval do
+        # class_eval makes self == ActiveRecord::Base, and makes def define instance methods.
+        extend ClassMethods
+        # If has_many were an instance method, we could do this
+        #   alias_method_chain :has_many, :association_option; end            
+        # but it's a class method, so we have to do the alias_method_chain on  
+        # the meta-class for ActiveRecord::Base, which is what class << self does.   
+        class << self;  alias_method_chain :method_missing, :create_or_update;  end
+      end
+  end
+
+
+end
+
+end

data/lib/webget_ruby_rails/active_record/connection_adapters/abstract/schema_statements.rb

@@ -0,0 +1,24 @@
+module ActiveRecord
+  module ConnectionAdapters 
+    module SchemaStatements
+
+      # Add a column and its index.
+      # This just calls #add_column then #add_index
+
+      def add_column_and_index(table_name, column_name, type, options = {})
+        add_column(table_name, column_name, type, options)
+        add_index(table_name, column_name, type, options)
+      end
+
+
+      # Remove a column and its index in one step.
+      # This just calls #remove_column then #remove_index.
+
+      def remove_column_and_index(table_name, column_name, type, options = {})
+        remove_column(table_name, column_name, type, options)
+        remove_index(table_name, column_name, type, options)
+      end
+
+    end
+  end
+end

data/lib/webget_ruby_rails/active_record/save_extensions.rb

@@ -0,0 +1,35 @@
+module ActiveRecord::SaveExtensions
+
+  # Save the record without validation, then reload it.
+  # If the record is valid then return true, otherwise raise RecordInvalid.
+  # This solves an issue we found with Rails associations not saving.
+  #
+  # By Andrew Carpenter (acarpen@wested.org)
+  #
+  # Deprecated, superceded by #save_redux!
+
+  def save_false_then_reload!
+    transaction do
+      save(false)
+      reload
+      valid? or raise ActiveRecord::RecordInvalid.new(self)
+    end
+    return true
+  end
+
+
+  # Save the record without validation, then reload, then save with validtion.
+  # This ensure that rails brings back the correct associations to validate.
+  # This solves an issue we found with Rails associations not saving.
+
+  def save_redux!
+    transaction do
+      save(false)
+      reload
+      save!
+    end
+    return true
+  end
+
+end
+ActiveRecord::Base.send(:include, ActiveRecord::SaveExtensions)

data/test/webget_ruby_rails/active_record/connection_adapters/abstract/schema_statements_test.rb

@@ -0,0 +1,9 @@
+require 'test/unit'
+require 'webget_ruby_rails'
+
+class SchemaStatementsTest < Test::Unit::TestCase
+
+  def test_placeholder
+  end
+
+end

data/test/webget_ruby_rails/active_record/save_extensions_test.rb

@@ -0,0 +1,7 @@
+require 'test/unit'
+require 'webget_ruby_rails'
+require 'active_record'
+
+class SaveExtensionsText < Test::Unit::TestCase
+end
+

data/test/webget_ruby_rails/active_record_test.rb

@@ -0,0 +1,64 @@
+require 'test/unit'
+require 'webget_ruby_rails'
+require 'active_record'
+
+begin
+ require 'sqlite3'
+rescue
+ # noop because sqlite may already be available,
+ # e.g. in JRuby on Ubuntu you can install it:
+ # apt-get install libsqlite3-ruby
+end
+
+begin
+  ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+rescue
+  raise ""+
+    "ActiveRecord cannot establish connection to sqlite3 database memory.\n" +
+    "Please verify that you have the sqlite3 database installed for testing.\n" +
+    "To install it for Ruby typically do: sudo gem install sqlite3-ruby\n" + 
+    "To install it for JRuby + Ubuntu do: sudo apt-get install libsqlite3-ruby"
+end
+
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :foos do |t|
+    t.string :a
+    t.string :b
+    t.string :c
+  end
+end
+
+class Foo < ActiveRecord::Base
+end
+
+class ActiveRecordTest < Test::Unit::TestCase
+
+  def test_prelim_count
+    assert_equal(0,Foo.count)
+  end
+
+  def test_prelim_create
+    f=Foo.new
+    f.a='aa'
+    f.b='bb'
+    f.c='cc'
+    f.save
+    assert_equal(1,Foo.count)    
+  end
+
+  def test_seed_with_create
+    n1=Foo.count
+    Foo.seed(:a,{:a=>'xxx',:b=>'yyy'})
+    n2=Foo.count
+    assert_equal(n1+1,n2)    
+  end
+
+  def test_seed_with_update
+    n1=Foo.count
+    f1=Foo.find(:first)
+    Foo.seed(:a,{:a=>f1.a,:b=>'bbb'})
+    n2=Foo.count
+    assert_equal(n1,n2)    
+  end
+
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: webget_ruby_rails
+version: !ruby/object:Gem::Version 
+  version: 1.7.4
+platform: ruby
+authors: 
+- WebGet
+autorequire: 
+bindir: bin
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDvDCCAyWgAwIBAgIJAIlSqEkDQaZIMA0GCSqGSIb3DQEBBQUAMIGbMQswCQYD
+  VQQGEwJVUzETMBEGA1UECBMKQ2FsaWZvcm5pYTEWMBQGA1UEBxMNU2FuIEZyYW5j
+  aXNjbzETMBEGA1UEChMKV2ViR2V0LmNvbTETMBEGA1UECxMKV2ViR2V0LmNvbTET
+  MBEGA1UEAxMKV2ViR2V0LmNvbTEgMB4GCSqGSIb3DQEJARYRd2ViZ2V0QHdlYmdl
+  dC5jb20wHhcNMDkwMjI2MTk0NDU4WhcNMTExMTIzMTk0NDU4WjCBmzELMAkGA1UE
+  BhMCVVMxEzARBgNVBAgTCkNhbGlmb3JuaWExFjAUBgNVBAcTDVNhbiBGcmFuY2lz
+  Y28xEzARBgNVBAoTCldlYkdldC5jb20xEzARBgNVBAsTCldlYkdldC5jb20xEzAR
+  BgNVBAMTCldlYkdldC5jb20xIDAeBgkqhkiG9w0BCQEWEXdlYmdldEB3ZWJnZXQu
+  Y29tMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDXCFYfW6hCQl0ToNjaMIXG
+  ZfPF6OoR20BO/Tg6V37qPi7gDSZ6vIC6Mxcs8LtEcju85cD9lnKKl/lo4S5/w9Ha
+  hGD2ZFFfbF8420X5Za5G2KuriS3GzRz7F5dKCTjb1NH9TPlgOc71bcrDmCwwtFJl
+  T+tdfBju0YxLSBiMXf4y5QIDAQABo4IBBDCCAQAwHQYDVR0OBBYEFHB1kXO/Xd4g
+  G+AJ2/wwh6JOWXzNMIHQBgNVHSMEgcgwgcWAFHB1kXO/Xd4gG+AJ2/wwh6JOWXzN
+  oYGhpIGeMIGbMQswCQYDVQQGEwJVUzETMBEGA1UECBMKQ2FsaWZvcm5pYTEWMBQG
+  A1UEBxMNU2FuIEZyYW5jaXNjbzETMBEGA1UEChMKV2ViR2V0LmNvbTETMBEGA1UE
+  CxMKV2ViR2V0LmNvbTETMBEGA1UEAxMKV2ViR2V0LmNvbTEgMB4GCSqGSIb3DQEJ
+  ARYRd2ViZ2V0QHdlYmdldC5jb22CCQCJUqhJA0GmSDAMBgNVHRMEBTADAQH/MA0G
+  CSqGSIb3DQEBBQUAA4GBADzVXlwuff0/w3yK4LflGKKhtC3oChIrwmSyP6tk628N
+  BHokpc4Kz63xSXqzYTnBS7rFBwlYThtNalQeWmoUjGh3Z0ZR0JlhU0ln8899LuJ3
+  DXnLFY0cVuBnNDMOOFl8vk1qIcZjcTovhzgcixpG6Uk5qmUsKHRLQf4oQJx7TfLK
+  -----END CERTIFICATE-----
+
+date: 2010-02-19 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: webget_ruby_ramp
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.7.4
+    version: 
+description: 
+email: webget@webget.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.rdoc
+- LICENSE.txt
+- lib/webget_ruby_rails.rb
+- lib/webget_ruby_rails/active_record.rb
+- lib/webget_ruby_rails/active_record/connection_adapters/abstract/schema_statements.rb
+- lib/webget_ruby_rails/active_record/save_extensions.rb
+has_rdoc: true
+homepage: http://webget.com/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: "WebGet Ruby Gem: Rails extensions"
+test_files: 
+- test/webget_ruby_rails/active_record_test.rb
+- test/webget_ruby_rails/active_record/connection_adapters/abstract/schema_statements_test.rb
+- test/webget_ruby_rails/active_record/save_extensions_test.rb