store_method 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5703250dc3600052cdd2e94d6398ff4fca22869e
+  data.tar.gz: efae7bf1cddb58c243efd6fab692a36c4211a4af
+SHA512:
+  metadata.gz: ff2d98a02deecc13e60facc13b2131237fb9f985c1693d59b2f1d5951e3246a07fd59b9aa28da3404e264465cfed98dab5e317cdb74af9726a855019adcf56d9
+  data.tar.gz: f9ac267230d2ac56f9087ef31a39aa68fcb31bcacd299c4aee60cc9f295ae52761f7380fa992b5052124ac9bd0b49bbfb4ceec183617a1b77e1b6362da4e813a

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+.rvmrc
+Gemfile.lock
+store_method.sqlite3
+spec/debug.log

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cache_method.gemspec
+gemspec
+
+gem "database_cleaner", "1.0.1"
+gem 'activerecord-jdbcsqlite3-adapter', :platforms => :jruby
+gem 'sqlite3', :platforms => :ruby

data/README.markdown

@@ -0,0 +1,84 @@
+# store_method
+
+This gem offers very simple approach to cache heavy ActiveRecord instance methods in the database. You just add corresponding field to the database, add store_method line and then just drink your coffee, no other changes needed!
+
+Heavy methods are methods which consume some time and resources to compute their returned value. If that value does not change over time, storing it to the database is a good idea. Actually this functionality is very similar to existing cachethod, cache_method and method_cacheable gems, but all those gems are using Rails.cache to store computed values. In case if you don't want to bother with Rails.cache, use store_method to store computed values right in the database, it's clean and simple!
+
+## Install
+
+In Gemfile
+
+```ruby
+gem 'store_method', github: 'fomichov/store_method'
+```
+
+Then run
+
+```
+bundle install
+```
+
+## Basic Usage
+
+Consider gravatar_url instance method which fetches corresponding Gravatar URL for User. This method always takes some time to request www.gravatar.com API so let's store its returned value in the corresponding database field.
+
+```ruby
+class User < ActiveRecord::Base
+  def gravatar_url
+    ...
+  end
+end
+```
+
+First create corresponding database field
+```
+rails g migration AddGravatarURLToUsers gravatar_url:string
+```
+
+(Notice that database column type should match the type that our method returns, any valid column type is supported)
+
+Then include **StoreMethod** module to our model class, and add store_method call with a method name
+
+```ruby
+class User < ActiveRecord::Base
+  include StoreMethod
+  store_method :gravatar_url
+
+  def gravatar_url
+    ...
+  end
+end
+```
+
+Passing multiple method names is also supported:
+```ruby
+store_methods :gravatar_url, :friends_count
+```
+
+## Refreshing value
+In case if you need to refresh stored value, call stored method with "refresh_" prefix like this:
+
+```ruby
+user = User.first
+user.refresh_gravatar_url
+SQL (5.7ms)  UPDATE `users` SET `users`.`avatar_url` = 'http://www.gravatar.com/avatar/fc383b8294226d72f3a7828eeef86987?d=https%3A%2F%2Fidenticons.github.com%2Ffc383b8294226d72f3a7828eeef86987.png&s=42' WHERE `users`.`id` = 1
+ => "http://www.gravatar.com/avatar/fc383b8294226d72f3a7828eeef86987?d=https%3A%2F%2Fidenticons.github.com%2Ffc383b8294226d72f3a7828eeef86987.png&s=42" 
+```
+
+
+## Caveats
+
+Arguments are also supported
+
+## Contributing to store_method
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project
+* Implement your fix or feature
+* Add tests for your changes and make sure that all tests are passing
+* Post a pull request
+
+## License
+
+This library is distributed under the Beerware license.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/store_method.rb

@@ -0,0 +1,59 @@
+module StoreMethod
+  def self.included base
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    def store_method *names
+      @methods_to_store ||= {}
+      
+      names.each do |name|
+        if instance_methods.include?(name.to_sym)
+          store_method_create(name)
+        else
+          @methods_to_store[name.to_sym] = true
+        end
+      end
+    end
+
+    alias_method :store_methods, :store_method
+
+    def method_added name
+      super
+      return if @methods_to_store.nil? || @methods_to_store[name].nil?
+      @methods_to_store.delete(name)
+      store_method_create(name)
+    end
+
+    def store_method_create name
+      alias_method "#{name}_orig", name
+
+      define_method(name) do |*args|
+        if args.empty?
+          val = attributes[name.to_s]
+          unless val
+            val = send("#{name}_orig")
+            if new_record?
+              assign_attributes({name.to_sym => val})
+            else
+              update_column(name.to_sym, val)
+            end
+          end
+          return val
+        else
+          return send("#{name}_orig", *args)
+        end
+      end
+      
+      define_method("refresh_#{name}") do |*args|
+        val = send("#{name}_orig")
+        if new_record?
+          assign_attributes({name.to_sym => val})
+        else
+          update_column(name.to_sym, val)
+        end
+        return val
+      end
+    end
+  end
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module StoreMethod
+  VERSION = "0.1.0"
+end

data/spec/database.yml

@@ -0,0 +1,3 @@
+sqlite3:
+  adapter: sqlite3
+  database: store_method.sqlite3

data/spec/lib/store_method_spec.rb

@@ -0,0 +1,62 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe "StoreMethod" do
+  context "new record" do
+    let(:user) { User.new }
+    it "should actually call the process method once" do
+      expect(user).to receive(:process).and_return("JohnJohn").once
+      2.times { expect(user.name).to eq("JohnJohn") }
+    end
+
+    it "should create _orig method" do
+      expect(user.name_orig).to eq("JohnJohn")
+    end
+
+    it "should support refresh method" do
+      expect(user.name).to eq("JohnJohn")
+      expect(user).to receive(:process).and_return("AdamAdam")
+      expect(user.refresh_name).to eq("AdamAdam")
+      expect(user.attributes["name"]).to eq("AdamAdam")
+    end
+
+    it "should pass attributes" do
+      expect(user.name).to eq("JohnJohn")
+      expect(user.name("Adam")).to eq("AdamAdam")
+      expect(user.attributes["name"]).to eq("JohnJohn")
+    end
+
+    it "should save valid record" do
+      expect(user.name).to eq("JohnJohn") 
+      expect { user.save }.to change{User.count}.by(1)
+      expect(user.read_attribute(:name)).to eq("JohnJohn")
+    end
+  end
+
+  context "existing record" do
+    before(:each) do
+      @user = User.create!
+    end
+
+    it "should actually call the process method once" do
+      expect(@user).to receive(:process).and_return("JohnJohn").once
+      2.times { expect(@user.name).to eq("JohnJohn") }
+    end
+
+    it "should create _orig method" do
+      expect(@user.name_orig).to eq("JohnJohn")
+    end
+
+    it "should support refresh method" do
+      expect(@user.name).to eq("JohnJohn")
+      expect(@user).to receive(:process).and_return("AdamAdam")
+      expect(@user.refresh_name).to eq("AdamAdam")
+      expect(@user.attributes["name"]).to eq("AdamAdam")
+    end
+
+    it "should pass attributes" do
+      expect(@user.name).to eq("JohnJohn")
+      expect(@user.name("Adam")).to eq("AdamAdam")
+      expect(@user.attributes["name"]).to eq("JohnJohn")
+    end
+  end
+end

data/spec/schema.rb

@@ -0,0 +1,5 @@
+ActiveRecord::Schema.define :version => 0 do
+  create_table :users, :force => true do |t|
+    t.string :name
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+require 'rubygems'
+require 'bundler'
+require 'logger'
+require 'rspec'
+require 'active_record'
+require 'database_cleaner'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+require 'store_method'
+
+ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + '/debug.log')
+ActiveRecord::Base.configurations = YAML::load_file(File.dirname(__FILE__) + '/database.yml')
+ActiveRecord::Base.establish_connection(:sqlite3)
+
+load(File.dirname(__FILE__) + '/schema.rb')
+load(File.dirname(__FILE__) + '/user.rb')
+
+RSpec.configure do |config|
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+  config.filter_run_excluding :exclude => true
+
+  config.mock_with :rspec
+
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :truncation
+    DatabaseCleaner.clean
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end

data/spec/user.rb

@@ -0,0 +1,12 @@
+class User < ActiveRecord::Base
+  include StoreMethod
+  store_method :name
+
+  def process(s)
+    s * 2
+  end
+
+  def name(first_name = "John")
+    process(first_name)
+  end
+end

data/store_method.gemspec

@@ -0,0 +1,23 @@
+require File.expand_path("../lib/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "store_method"
+  s.version     = StoreMethod::VERSION
+  s.authors     = ["Vitaly Fomichov"]
+  s.email       = ["fomichov@gmail.com"]
+  s.homepage    = "https://github.com/fomichov/store_method"
+  s.summary     = %q{Simple ActiveRecord extension to store calculated values in the corresponding database fields}
+  s.description = %q{Simple ActiveRecord extension to store calculated values in the corresponding database fields}
+
+  # s.rubyforge_project = "store_method"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_dependency "activerecord", ['>= 3.0']
+  s.add_development_dependency "bundler", ['>= 1.0.0', '<= 1.4']
+  s.add_development_dependency 'rspec', ["= 3.1.0"]
+  s.add_development_dependency "database_cleaner", "1.0.1"
+  s.add_development_dependency "rake", ">= 0.9.2"
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: store_method
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vitaly Fomichov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - <=
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - <=
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+description: Simple ActiveRecord extension to store calculated values in the corresponding
+  database fields
+email:
+- fomichov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG
+- Gemfile
+- README.markdown
+- Rakefile
+- lib/store_method.rb
+- lib/version.rb
+- spec/database.yml
+- spec/lib/store_method_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb
+- spec/user.rb
+- store_method.gemspec
+homepage: https://github.com/fomichov/store_method
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Simple ActiveRecord extension to store calculated values in the corresponding
+  database fields
+test_files:
+- spec/database.yml
+- spec/lib/store_method_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb
+- spec/user.rb
+has_rdoc: