codable 5.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0a3b130028ee52ca86a896fcd2568a7560b8a29d
+  data.tar.gz: e3206fa1ecf7a2623df8a539b22512990730c4e6
+SHA512:
+  metadata.gz: 42fc84008800d64f8aef58a45ff3412c404e338e6dae12d6c5ebd0e0bbc4e9bf87a2d15d89669823789dae1b98e4b5b523a27e59cef11221ab3ee0b8cb4c0a3e
+  data.tar.gz: e1df4235c569cbee2a1c93d04ef53eeb180a6ee4751eeaf7553f4e39547d0688390ec24f7b00f7edc14beef1eda029eda58bf61e861a6cfcfae51ba4f2de2cd2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Song Huang
+
+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,31 @@
+# Codable
+Rails plugin for the attribute - code
+
+## Installation
+Include the gem to your Gemfile:
+```ruby
+gem 'codable', '~> 6.x' # For Rails 6.x
+```
+
+## Usage
+Include Codable for your model:
+```ruby
+class Platform < ApplicationRecord
+  include Codable
+  self.codable_key = :other # You needn't do this until the attribute is not `code`
+end
+```
+
+```ruby
+Platform.create!([
+  { id: 1, code: 'linux' },
+  { id: 2, code: 'macos' },
+])
+Platform[:linux]        # => #<Platform: 1>
+Platform[:linux].id     # => 1, hit cache this time
+Platform[:linux].linux? # => true, hit cache this time
+Platform[:linux].macos? # => false, hit cache this time
+```
+
+## 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,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Codable'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+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/codable.rb

@@ -0,0 +1,49 @@
+require 'codable/railtie'
+
+# Rails plugin for the attribute - code
+module Codable
+  extend ActiveSupport::Concern
+
+  class_methods do
+    attr_accessor :codable_key
+
+    def [](value)
+      raise ArgumentError, 'value must be present' unless value.present?
+
+      Rails.cache.fetch("#{_codable_cache_key_prefix}/#{value}") do
+        find_by!(codable_key => value)
+      end
+    end
+
+    def _codable_cache_key_prefix
+      "codable/#{table_name}/#{codable_key}"
+    end
+  end
+
+  included do
+    raise ArgumentError, 'Class included must be a ActiveRecord' unless is_a?(Class) && self <= ActiveRecord::Base
+
+    after_commit :_codable_clear_expired_cache, on: %i[update destroy]
+    self.codable_key = :code
+  end
+
+  def method_missing(method, *args)
+    if method.to_s.end_with?('?')
+      attributes[self.class.codable_key.to_s] == method.to_s.chomp('?')
+    else
+      super
+    end
+  end
+
+  def respond_to_missing?(method, include_private = false)
+    method.to_s.end_with?('?') || super
+  end
+
+  private
+
+  def _codable_clear_expired_cache
+    # When the codable_key field is modified, we need to remove the cache of the original value
+    value = attribute_before_last_save(self.class.codable_key.to_s) || attributes[self.class.codable_key.to_s]
+    Rails.cache.delete("#{self.class._codable_cache_key_prefix}/#{value}")
+  end
+end

data/lib/codable/railtie.rb

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

data/lib/codable/version.rb

@@ -0,0 +1,3 @@
+module Codable
+  VERSION = '5.0.0'.freeze
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: codable
+version: !ruby/object:Gem::Version
+  version: 5.0.0
+platform: ruby
+authors:
+- Song Huang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.x
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.x
+description: Rails plugin for the attribute - code
+email:
+- songhuangcn@qq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/codable.rb
+- lib/codable/railtie.rb
+- lib/codable/version.rb
+homepage: https://github.com/songhuangcn/codable
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Rails plugin for the attribute - code
+test_files: []