mongo_method_storable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 46becd59b1203a6408011c32a7c96b154ecc1eb3
+  data.tar.gz: 18ad6716bfb66c16573a66af0b2fa1018c1e2b8f
+SHA512:
+  metadata.gz: 3b0b7a0468f02a2ff3713afa1e890fdd72e98b13fdbe0c04b5ca2fb3c41e9d6fa6bd3941a88c2889a42d7b6c2ad5d31c1ffbafd45a8a9a44944a5c62369302e3
+  data.tar.gz: c0dedda0f01ce4d4faee33788c4a880bfb923c60c90dc46d8bbb994f1aa6b601eb643051bc6688c46b492144c00db1ddba3be9dcb08f6dce19babb3171299f95

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mongo_method_storable.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Andy Pickler
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,46 @@
+# MongoMethodStorable
+
+MongoMethodStorage allows you to store the output of methods in a Mongoid::Document class into MongoDB dynamic fields.  It also lazily stores the output, in that the value is only stored the first time the method is called on a given object.  Subsequent calls to the method will just read the attribute value from the document, eliminating the "cost" of executing the method.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mongo_method_storable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongo_method_storable
+
+## Usage
+
+`include MongoMethodStorable`
+
+```ruby
+def some_method
+  # complex/expensive algorithm
+end
+mongo_store :some_method
+```
+
+## Limitations
+
+1. Methods can take no arguments (currently)
+2. There is no option (currently) to force the method to be evaluated after the first time.
+3. No tests have been written on this code (caveat: it *is* being used in at least one production application)
+4. This is my first "real" published Ruby gem
+5. A bunch of other limitations I'm sure I'll think of over time
+
+## Contributing
+
+1. Fork it ( https://github.com/BigGillyStyle/mongo_method_storable/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/gem_tasks"
+
+Dir.glob('tasks/**/*.rake').each(&method(:import))

data/lib/mongo_method_storable.rb

@@ -0,0 +1,33 @@
+require "mongo_method_storable/version"
+# require "mongoid/attributes"
+
+module MongoMethodStorable
+  MONGO_STORE_PREFIX = '_old_mstore_'
+
+  def mongo_store(method_name)
+    old_method_name = "#{MONGO_STORE_PREFIX + method_name.to_s}".to_sym
+    raise AlreadyAliasedError.new("Already aliased #{method_name}") if method_defined?(old_method_name)
+    alias_method old_method_name, method_name
+
+    if instance_method(method_name).arity == 0
+      define_method method_name do
+        attr_val = read_attribute method_name
+        return attr_val if attr_val
+        attr_val = send old_method_name
+        write_attribute(method_name, attr_val)
+        save!
+        attr_val
+      end
+    else
+      # deal with this case when I need to
+    end
+  end
+
+  def storable_methods
+    self.instance_methods.
+      select {|m| self.instance_method(m).name.to_s.start_with? MONGO_STORE_PREFIX}.
+      map {|m| m.slice(MONGO_STORE_PREFIX.length..m.length).to_sym}
+  end
+
+  class AlreadyAliasedError < RuntimeError; end
+end

data/lib/mongo_method_storable/version.rb

@@ -0,0 +1,3 @@
+module MongoMethodStorable
+  VERSION = "0.0.1"
+end

data/mongo_method_storable.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongo_method_storable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mongo_method_storable"
+  spec.version       = MongoMethodStorable::VERSION
+  spec.authors       = ["Andy Pickler"]
+  spec.email         = ["andy.pickler@gmail.com"]
+  spec.summary       = %q{Store the output of methods in a Mongoid::Document class into MongoDB dynamic fields.}
+  spec.description   = %q{Store the output of methods in a Mongoid::Document class into MongoDB dynamic fields. Lazily evaluates methods and stores the output in document...subsequent calls simply read the attribute value and do not run the method.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1.0"
+  spec.add_runtime_dependency "mongoid", "~> 4.0.0"
+end

data/spec/mongo_method_storable_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe MongoMethodStorable do
+
+  describe '::mongo_store' do
+
+    it 'stores the output of a method in a Mongoid document' do
+      pending 'me gettimg the time to implement tests'
+      fail
+    end
+
+  end
+
+  describe '::storable_methods' do
+
+    it 'lists all the methods that use ::mongo_store' do
+      pending 'me gettimg the time to implement tests'
+      fail
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'mongo_method_storable'
+

data/tasks/rspec.rake

@@ -0,0 +1,7 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'progress']
+end
+
+task :default => :spec

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: mongo_method_storable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andy Pickler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !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: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+description: Store the output of methods in a Mongoid::Document class into MongoDB
+  dynamic fields. Lazily evaluates methods and stores the output in document...subsequent
+  calls simply read the attribute value and do not run the method.
+email:
+- andy.pickler@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mongo_method_storable.rb
+- lib/mongo_method_storable/version.rb
+- mongo_method_storable.gemspec
+- spec/mongo_method_storable_spec.rb
+- spec/spec_helper.rb
+- tasks/rspec.rake
+homepage: ''
+licenses:
+- MIT
+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.4.2
+signing_key: 
+specification_version: 4
+summary: Store the output of methods in a Mongoid::Document class into MongoDB dynamic
+  fields.
+test_files:
+- spec/mongo_method_storable_spec.rb
+- spec/spec_helper.rb