easy_tags 0.1.0 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9d001007c468197af668ff53d0cd2606b627e854c375b3661ef873f31679ecd
-  data.tar.gz: 8e961637ec99daa3b300816fae2b6e4fbcf0df9228f8374f55f404075a547187
+  metadata.gz: 8287fdecc7f7ef46be4d02d25db0781471ce1bd039a4e6f0ed357d4ff9ba0a46
+  data.tar.gz: 2d3e23375449f4c229948825e6aadf8194a76bd47d00a480050140124db0fa10
 SHA512:
-  metadata.gz: 3dfe8cc27d54a09bb33a30d05b9f666d7083af4489cc4e142e1cad79d6d5134911148eb67bcab5ffa8c996478dab2cc527073dd4d7ff53f6487447a8070cf26e
-  data.tar.gz: f5ded6f869d9a5f5388ca3c380d2c9513fbc281219a5efb025aa95a0131c9b858e6714c7d6cd5b3f12cf22ac6ba2ccde2154bbeda129340ef8b71a533d43a9fa
+  metadata.gz: eef88df3c81e4f130f1a59aaad9c6c7ea74752bc8e4bdc6279f8ee716be7fd27d7f576c7c132aca38a3d3e93aa3052dc2b838a3e9f505be08a41225cbe7636da
+  data.tar.gz: 1302a9207d12f0980cca36d93f01595d1293456f4d2a8a28427a63857a236ad78aae83daffd4b8881c28dc2c856eadc999808cb7a2b2e0641521609f3e0651ff

data/.travis.yml

@@ -14,16 +14,14 @@ script:
 after_script:
   - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
 rvm:
-  - 2.3.8
-  - 2.4.5
   - 2.5.3
   - 2.6.0
   - ruby-head
 gemfile:
   - Gemfile
-  - gemfiles/activerecord_5.0.gemfile
   - gemfiles/activerecord_5.1.gemfile
   - gemfiles/activerecord_5.2.gemfile
+  - gemfiles/activerecord_6.0.gemfile
 matrix:
   allow_failures:
     - rvm: ruby-head

data/Appraisals

@@ -1,8 +1,3 @@
-appraise 'activerecord-5.0' do
-  gem 'activerecord', '~> 5.0.0'
-  gem 'activesupport', '~> 5.0.0'
-end
-
 appraise 'activerecord-5.1' do
   gem 'activerecord', '~> 5.1.0'
   gem 'activesupport', '~> 5.1.0'
@@ -12,3 +7,8 @@ appraise 'activerecord-5.2' do
   gem 'activerecord', '~> 5.2.0'
   gem 'activesupport', '~> 5.2.0'
 end
+
+appraise 'activerecord-6.0' do
+  gem 'activerecord', '~> 6.0.0'
+  gem 'activesupport', '~> 6.0.0'
+end

data/CHANGELOG.md

@@ -0,0 +1,38 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.2.4] - 2020-06-09
+### Fixed
+- Fixed tags eager loading
+
+## [0.2.3] - 2020-01-15
+### Added
+- Rails 6.0 support
+
+## [0.2.2] - 2019-10-24
+### Fixed
+- Fixed inspect and compare for context objects (delegate to tags list) that may have affected debug and testing
+
+## [0.2.1] - 2019-10-24
+### Fixed
+- Fixed `.add` and `.remove` methods not implementing properly dirty behavior
+
+## [0.2.0] - 2019-09-12
+### Added
+- `[context]_list_persisted` interface method for accessing persisted/previous tag list string
+
+## [0.1.0] - 2019-07-15
+Initial release
+
+[Unreleased]: https://github.com/iiwo/easy_tagscompare/v0.2.4...HEAD
+[0.2.4]: https://github.com/iiwo/easy_tags/compare/v0.2.3...v0.2.4
+[0.2.3]: https://github.com/iiwo/easy_tags/compare/v0.2.2...v0.2.3
+[0.2.2]: https://github.com/iiwo/easy_tags/compare/v0.2.1...v0.2.2
+[0.2.1]: https://github.com/iiwo/easy_tags/compare/v0.2.0...v0.2.1
+[0.2.0]: https://github.com/iiwo/easy_tags/compare/v0.1.0...v0.2.0
+[0.1.0]: https://github.com/iiwo/easy_tags/releases/tag/v0.1.0

data/README.md

@@ -90,12 +90,13 @@ easy_tags_on :highlights
 
 the following methods will be auto-generated and made available for your model instance (`highlights` being an example context name):
 
-| description                        | method                    |
-|------------------------------------|---------------------------|
-| set tags using string of tag names | `highlights_list=(value)` |
-| get string of tag names            | `highlights_list`         |
-| set tags with array of tag names   | `highlights=(value)`      |
-| get array of tag names             | `highlights`              |
+| description                        | method                           |
+|------------------------------------|----------------------------------|
+| set tags using string of tag names | `highlights_list=(value)`        |
+| get string of tag names            | `highlights_list`                |
+| get string of persisted tag names  | `highlights_list_persisted`      |
+| set tags with array of tag names   | `highlights=(value)`             |
+| get array of tag names             | `highlights`                     |
 
 - the String accessor is helpful when working with client side tagging UI solutions such as ie. [select2](https://select2.org/tagging)
 - the Array accessor gives you convenient array item manipulation

data/easy_tags.gemspec

@@ -2,6 +2,7 @@ lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'easy_tags/version'
 
+# rubocop:disable Metrics/BlockLength
 Gem::Specification.new do |spec|
   spec.name = 'easy_tags'
   spec.version = EasyTags::VERSION
@@ -12,6 +13,12 @@ Gem::Specification.new do |spec|
   spec.description = 'Easy tagging for Rails'
   spec.homepage = 'https://github.com/iiwo/easy_tags'
   spec.license = 'MIT'
+  spec.metadata    = {
+    'homepage_uri' => 'https://github.com/iiwo/easy_tags',
+    'changelog_uri' => 'https://github.com/iiwo/easy_tags/blob/master/CHANGELOG.md',
+    'source_code_uri' => 'https://github.com/iiwo/easy_tags',
+    'bug_tracker_uri' => 'https://github.com/iiwo/easy_tags/issues'
+  }
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
@@ -20,14 +27,16 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'activerecord', '~> 5.0'
-  spec.add_runtime_dependency 'activesupport', '~> 5.0'
+  spec.add_runtime_dependency 'activerecord', '>= 5.0', '< 6.1'
+  spec.add_runtime_dependency 'activesupport', '>= 5.0', '< 6.1'
 
   spec.add_development_dependency 'appraisal'
   spec.add_development_dependency 'database_cleaner'
+  spec.add_development_dependency 'db-query-matchers'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rspec-rails'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'simplecov-console'
-  spec.add_development_dependency 'sqlite3', '~> 1.3.6'
+  spec.add_development_dependency 'sqlite3'
 end
+# rubocop:enable Metrics/BlockLength

data/gemfiles/activerecord_5.1.gemfile

@@ -1,8 +1,8 @@
 # This file was generated by Appraisal
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-gem 'activerecord', '~> 5.1.0'
-gem 'activesupport', '~> 5.1.0'
+gem "activerecord", "~> 5.1.0"
+gem "activesupport", "~> 5.1.0"
 
-gemspec path: '../'
+gemspec path: "../"

data/gemfiles/activerecord_5.2.gemfile

@@ -1,8 +1,8 @@
 # This file was generated by Appraisal
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-gem 'activerecord', '~> 5.2.0'
-gem 'activesupport', '~> 5.2.0'
+gem "activerecord", "~> 5.2.0"
+gem "activesupport", "~> 5.2.0"
 
-gemspec path: '../'
+gemspec path: "../"

data/gemfiles/activerecord_6.0.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 6.0.0"
+gem "activesupport", "~> 6.0.0"
+
+gemspec path: "../"

data/lib/easy_tags.rb

@@ -5,6 +5,7 @@ require 'active_record'
 module EasyTags
   extend ActiveSupport::Autoload
 
+  autoload :DirtyMethods, 'easy_tags/dirty_methods'
   autoload :Tag, 'easy_tags/tag'
   autoload :TaggableMethods, 'easy_tags/taggable_methods'
   autoload :TaggableContextMethods, 'easy_tags/taggable_context_methods'

data/lib/easy_tags/dirty_methods.rb

@@ -0,0 +1,26 @@
+module EasyTags
+  # Handles dirty behaviour
+  module DirtyMethods
+    RAILS_6 = ::ActiveRecord.gem_version >= ::Gem::Version.new('6.0.0')
+
+    def _mark_dirty(context:, taggable_context:)
+      _set_dirty_previous_value(attribute_name: "#{context}_list", value: taggable_context.persisted_tags.to_s)
+      write_attribute("#{context}_list", taggable_context.tags.to_s)
+      attribute_will_change!("#{context}_list")
+    end
+
+    if RAILS_6
+      def _set_dirty_previous_value(attribute_name:, value:)
+        @attributes[attribute_name] = ActiveModel::Attribute.from_user(
+          attribute_name,
+          value,
+          ActiveModel::Type::Value.new
+        )
+      end
+    else
+      def _set_dirty_previous_value(attribute_name:, value:)
+        set_attribute_was(attribute_name, value)
+      end
+    end
+  end
+end

data/lib/easy_tags/taggable_context.rb

@@ -2,11 +2,11 @@ module EasyTags
   # Handles tag context manipulation
   class TaggableContext
     # @param [String, Symbol] context
-    # @param [Proc] refresh_persisted_tags
+    # @param [ActiveRecord::Relation] tags_association
     # @param [Proc] on_change
-    def initialize(context:, refresh_persisted_tags:, on_change:)
+    def initialize(context:, tags_association:, on_change:)
       self.context = context
-      self.refresh_persisted_tags = refresh_persisted_tags
+      self.tags_association = tags_association
       self.on_change = on_change
     end
 
@@ -22,7 +22,7 @@ module EasyTags
 
     # @return [TagList]
     def persisted_tags
-      @persisted_tags ||= TagList.new(refresh_persisted_tags.call)
+      @persisted_tags ||= preloaded_persisted_tags
     end
 
     # @param [String, Symbol] value
@@ -30,7 +30,7 @@ module EasyTags
     def update(value)
       @tags = TagList.new(value)
 
-      on_change.call(self) if changed?
+      notify_change
     end
 
     # @return [TagList]
@@ -49,8 +49,51 @@ module EasyTags
       @persisted_tags = nil
     end
 
+    # Add tags to the tag_list. Duplicate or blank tags will be ignored.
+    #
+    # Example:
+    #   tag_list.add('Fun', 'Happy')
+    def add(*names)
+      tags.add(*names).tap do
+        notify_change
+      end
+    end
+
+    # Remove item from list
+    #
+    # Example:
+    #   tag_list.remove('Issues')
+    def remove(value)
+      tags.remove(value).tap do
+        notify_change
+      end
+    end
+
+    delegate :==, :<=>, :to_s, :inspect, :hash, to: :tags
+
     private
 
-      attr_accessor :context, :refresh_persisted_tags, :on_change
+      attr_accessor :context, :tags_association, :on_change
+
+      def respond_to_missing?(name, _include_private = false)
+        tags.respond_to?(name)
+      end
+
+      def method_missing(name, *args, &block)
+        return super unless respond_to_missing?(name)
+
+        tags.send(name, *args, &block)
+      end
+
+      def notify_change
+        on_change.call(self) if changed?
+      end
+
+      def preloaded_persisted_tags
+        return TagList.new(tags_association.reload.map(&:name)) if @preloaded
+
+        @preloaded = true
+        TagList.new(tags_association.map(&:name))
+      end
   end
 end

data/lib/easy_tags/taggable_context_methods.rb

@@ -33,7 +33,7 @@ module EasyTags
           attribute :#{context}_list, ActiveModel::Type::Value.new
 
           def #{context}
-            _taggable_context(:#{context}).tags
+            _taggable_context(:#{context})
           end
 
           def #{context}=(value)
@@ -49,6 +49,10 @@ module EasyTags
             _taggable_context(:#{context}).update(value)
             #{context}_list
           end
+
+          def #{context}_list_persisted
+            _taggable_context(:#{context}).persisted_tags.to_s
+          end
         RUBY
       end
     end

data/lib/easy_tags/taggable_methods.rb

@@ -14,14 +14,6 @@ module EasyTags
             inverse_of: :taggable
           )
 
-          has_many(
-            :base_tags,
-            through: :taggings,
-            source: :tag,
-            class_name: '::EasyTags::Tag',
-            inverse_of: :tag
-          )
-
           after_save :_update_taggings, :_refresh_tagging
           after_find :_refresh_tagging
 
@@ -65,18 +57,12 @@ module EasyTags
               end
             end
 
-            def _mark_dirty(context:, taggable_context:)
-              write_attribute("#{context}_list", taggable_context.tags.to_s)
-              set_attribute_was("#{context}_list", taggable_context.persisted_tags.to_s)
-              attribute_will_change!("#{context}_list")
-            end
+            include DirtyMethods
 
             def _taggable_context(context)
               _taggable_contexts[context] ||= TaggableContext.new(
                 context: context,
-                refresh_persisted_tags: lambda {
-                  taggings.joins(:tag).where(context: context).pluck(:name)
-                },
+                tags_association: public_send("#{context}_tags"),
                 on_change: lambda { |tag_context|
                   _mark_dirty(context: context, taggable_context: tag_context)
                 }

data/lib/easy_tags/version.rb

@@ -1,3 +1,3 @@
 module EasyTags
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.4'.freeze
 end

metadata

@@ -1,43 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: easy_tags
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.4
 platform: ruby
 authors:
 - Iwo Dziechciarow
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-15 00:00:00.000000000 Z
+date: 2020-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +78,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: db-query-matchers
+  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: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -126,16 +152,16 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: '0'
 description: Easy tagging for Rails
 email:
 - iiwo@o2.pl
@@ -150,6 +176,7 @@ files:
 - ".travis.yml"
 - ".yardopts"
 - Appraisals
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - MIGRATING_FROM_AATO.MD
@@ -158,10 +185,11 @@ files:
 - bin/console
 - bin/setup
 - easy_tags.gemspec
-- gemfiles/activerecord_5.0.gemfile
 - gemfiles/activerecord_5.1.gemfile
 - gemfiles/activerecord_5.2.gemfile
+- gemfiles/activerecord_6.0.gemfile
 - lib/easy_tags.rb
+- lib/easy_tags/dirty_methods.rb
 - lib/easy_tags/generators/default.rb
 - lib/easy_tags/options/callback.rb
 - lib/easy_tags/options/collection.rb
@@ -180,7 +208,11 @@ files:
 homepage: https://github.com/iiwo/easy_tags
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/iiwo/easy_tags
+  changelog_uri: https://github.com/iiwo/easy_tags/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/iiwo/easy_tags
+  bug_tracker_uri: https://github.com/iiwo/easy_tags/issues
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -196,7 +228,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: EasyTags allows you to tag a single model on several contexts

data/gemfiles/activerecord_5.0.gemfile

@@ -1,8 +0,0 @@
-# This file was generated by Appraisal
-
-source 'https://rubygems.org'
-
-gem 'activerecord', '~> 5.0.0'
-gem 'activesupport', '~> 5.0.0'
-
-gemspec path: '../'