attribute_cache 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0aa502ac547d83cddb4d74e57f1f845517c959983aa8adfb9e2fb381eeefeb87
+  data.tar.gz: 99699a40fe6da7cc3f83a16b8895d03ed571709ea347941e4906a0a303ebae99
+SHA512:
+  metadata.gz: b3322e8c313a0895e2edccf339dc41473026debb37bb02b60c11a18fd701941a81f8de57ad3e4bbd914bda91e43ffbdcb76d8a0194725961293a5e670337b190
+  data.tar.gz: ec0fae3814b5ea459281d9fe7113ade28b416a0705fa53bafa16b0bca336b5db667d7465578ff8de026841cc1d5ed3b9b6e7b61662631cd5d982d96ad7c29c91

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Jacob Lockard
+
+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,28 @@
+# AttributeCache
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'attribute_cache'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install attribute_cache
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/attribute_cache.rb

@@ -0,0 +1,47 @@
+require 'attribute_cache/version'
+require 'attribute_cache/railtie'
+
+module AttributeCache
+  extend ActiveSupport::Concern
+
+  included do
+    def self.attribute_cache(name, attribute: nil, callback: nil, callback_prefix: 'calculate',
+                             attribute_prefix: 'cached', &block)
+      attribute ||= :"#{attribute_prefix}_#{name}"
+      callback ||= :"#{callback_prefix}_#{name}"
+
+      set_method = "set_#{name}"
+      set_save_method = "set_#{name}!"
+
+      define_method set_method do
+        send("#{attribute}=", call_callback(callback, self, &block))
+      end
+      define_method("invalidate_#{name}") { send(set_method) }
+
+      define_method set_save_method do
+        send(set_method)
+        save
+      end
+      define_method("invalidate_#{name}!") { send(set_save_method) }
+
+      define_method name do |save: true, keep_blanks: true|
+        setter = save ? set_save_method : set_method
+        send(setter) if send(attribute).nil? || !keep_blanks && send(attribute).blank?
+        send(attribute)
+      end
+    end
+  end
+
+  def call_callback(callback, record)
+    return yield if block_given?
+
+    case callback
+    when Symbol, String
+      record.send(callback)
+    when Proc
+      callback[]
+    else
+      raise 'An invalid callback was provided!'
+    end
+  end
+end

data/lib/attribute_cache/railtie.rb

@@ -0,0 +1,4 @@
+module AttributeCache
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/attribute_cache/version.rb

@@ -0,0 +1,3 @@
+module AttributeCache
+  VERSION = '0.1.0'
+end

data/lib/tasks/attribute_cache_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :attribute_cache do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: attribute_cache
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jacob Lockard
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.2.1
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.2
+description: A simple Rails plugin that provides the ability to cache a value to a
+  model attribute. The attribute will be automatically set if necessary, retrieved
+  when requested, and can be manually invalidated.
+email:
+- jacoblockard99@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/attribute_cache.rb
+- lib/attribute_cache/railtie.rb
+- lib/attribute_cache/version.rb
+- lib/tasks/attribute_cache_tasks.rake
+homepage: https://github.com/jacoblockard99/RailsAttributeCache.git
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jacoblockard99/RailsAttributeCache.git
+  source_code_uri: https://github.com/jacoblockard99/RailsAttributeCache.git
+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: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: A simple Rails plugin that provides the ability to cache a value to a model
+  attribute.
+test_files: []