activerecord-has_token 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 48ffcafd90bed6d0c825900ab47d73cbf57ab2667d63bcf27aebcebb6683d36f
+  data.tar.gz: f403122ab6ad8d5a6b42ce80f3e8a0929d8dbafe327f8ead72bec0db3d48036b
+SHA512:
+  metadata.gz: f579de191f1a91b7eb2c5ac68f37ca723b039389bde29d94936af7a73db7c6a2f7a13605956a7c6e2a4beecb86fe7e23348dc1adcde8c3d89d2fa164eabd5479
+  data.tar.gz: 55d945c435d4326604b9241e47afcba28f854e294dc51af76537d27754ad2a71cd9375261faa872549198dcc94fbe0ddad9a3e55c2f6a0dff4829b72efef07f6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Chris Bacon
+
+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/Rakefile

@@ -0,0 +1,34 @@
+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    = 'HasToken'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/activerecord-has_token.rb

@@ -0,0 +1,36 @@
+require 'active_record'
+
+module ActiveRecord
+  module HasToken
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def has_token(options = {})
+        attribute = options[:token_attribute] || :token
+        length = options[:length] || 6
+        
+        define_method("regenerate_#{attribute}") do
+          token = self.class.generate_token(attribute, length)
+
+          update_column(attribute, token)
+          token
+        end
+
+        before_create do 
+          self.send("#{attribute}=", self.class.generate_token(attribute, length)) unless self.send("#{attribute}?")
+        end
+      end
+
+      def generate_token(attribute, length)
+        random_token = nil
+        loop do
+          random_token = SecureRandom.alphanumeric(length)
+          break unless self.where(attribute => random_token).exists?
+        end
+        random_token
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.include(ActiveRecord::HasToken)

data/lib/activerecord-has_token/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module HasToken
+    VERSION = "0.0.3"
+  end
+end

data/test/has_token_test.rb

@@ -0,0 +1,37 @@
+require 'test_helper'
+
+class HasTokenTest < Minitest::Test
+  def setup 
+    @post = Post.new
+  end
+
+  def test_token_values_are_generated_for_specified_attributes_and_persisted_on_save
+    @post.save
+    refute_nil @post.token
+    refute_nil @post.slug
+  end
+
+  def test_length_is_used_for_token
+    @post.save
+    assert_equal @post.token.length, 6
+    assert_equal @post.slug.length, 20
+  end
+
+  def test_regeneration_of_token
+    @post.save
+    old_token = @post.token
+    old_slug = @post.slug
+    @post.regenerate_token
+    @post.regenerate_slug
+
+    refute_equal @post.token, old_token
+    refute_equal @post.slug, old_slug
+  end
+
+  def test_token_value_does_not_override_when_present
+    @post.slug = "custom-slug"
+    @post.save
+
+    assert_equal @post.slug, "custom-slug"
+  end
+end

data/test/models/post.rb

@@ -0,0 +1,4 @@
+class Post < ActiveRecord::Base
+  has_token
+  has_token token_attribute: :slug, length: 20
+end

data/test/schema.rb

@@ -0,0 +1,6 @@
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :posts do |t|
+    t.string :token
+    t.string :slug
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,20 @@
+testdir = File.dirname(__FILE__)
+$LOAD_PATH.unshift testdir unless $LOAD_PATH.include?(testdir)
+
+libdir = File.dirname(File.dirname(__FILE__)) + '/lib'
+$LOAD_PATH.unshift libdir unless $LOAD_PATH.include?(libdir)
+
+require "rubygems"
+require "activerecord-has_token"
+require "minitest/autorun"
+require "minitest/unit"
+
+Dir[File.join(__dir__, 'models', '*.rb')].each { |file| require file }
+
+DB_FILE = 'tmp/test_db'
+FileUtils.mkdir_p File.dirname(DB_FILE)
+FileUtils.rm_f DB_FILE
+
+ActiveRecord::Base.establish_connection :adapter => 'sqlite3', :database => DB_FILE
+
+load 'schema.rb'

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-has_token
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Chris Bacon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: minitest
+  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: sqlite3
+  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: pry
+  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'
+description: Unique token strings for your activerecord models
+email:
+- chris@crispybacon.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- lib/activerecord-has_token.rb
+- lib/activerecord-has_token/version.rb
+- test/has_token_test.rb
+- test/models/post.rb
+- test/schema.rb
+- test/test_helper.rb
+homepage: https://github.com/baconck/activerecord-has_token
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Unique token strings for your activerecord models
+test_files:
+- test/schema.rb
+- test/has_token_test.rb
+- test/models/post.rb
+- test/test_helper.rb