acts-as-taggable-on-mongoid 6.0.1.5 → 6.1.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17613f5a2c4b607cfe0401a9e78c9079d039ef3413de78992be7e10ad7757361
-  data.tar.gz: 1fa052c6dfdb384e8b1f1b1e05a1fb1b742ce87110b97ca91e2958e2b5984217
+  metadata.gz: a3389918de3bd83bfcc3ac3f82d9413d5a0f8ec076b8ae83c226d0787dd96158
+  data.tar.gz: a2e731e6cf8b57d91697d3feb0fc61acca0073bbda5ef41452768bb42ffb7f57
 SHA512:
-  metadata.gz: fa61f2bc79021884782cd2548ab0a402929e7f2ea76a585c0b149abf033ece404febf9f8aa4f4d83584d94e9c4adbc9a8f8735339bea440ea271679154718828
-  data.tar.gz: f9e98d90da85d6dfbdc3ece64a692808e24770c1e28da300bc9052117df77ea1037889596b033bd034579f41f337f43a2319fd656c7eee9e46ce94bd25eff4fa
+  metadata.gz: 0a21b7c8cb425ce8a839411cf2bd5db8985bacf7d16b527c0f5fcc58431af787603928aa14a4c5ae9dd200836756188242b908173b69293067c4b3db1906aef4
+  data.tar.gz: 67918b704a7b3cdeb1c200e883e806b12562e7724daa1f67a8ebeee2ce3452339e9b84c7de5916b9715193b6496be82b802598b073f35ce8d3ef4ba0d6981d24

data/.circleci/config.yml

@@ -7,7 +7,7 @@ jobs:
   build:
     docker:
       # specify the version you desire here
-       - image: circleci/ruby:2.5.1-stretch
+       - image: circleci/ruby:2.6.3-stretch
          environment:
            PRONTO_GITHUB_ACCESS_TOKEN: testing
        - image: mongo:3.6.7-jessie
@@ -33,6 +33,7 @@ jobs:
       - run:
           name: install dependencies
           command: |
+            gem install bundler
             bundle install --jobs=4 --retry=3 --path vendor/bundle
 
       - save_cache:

data/.rubocop.yml

@@ -57,8 +57,6 @@ Naming/PredicateName:
     - is_
     - has_
     - have_
-  NamePrefixBlacklist:
-    - is_
 Naming/RescuedExceptionsVariableName:
   PreferredName: error
 
@@ -204,7 +202,7 @@ Lint/AssignmentInCondition:
   AllowSafeAssignment: true
 Lint/DisjunctiveAssignmentInConstructor:
   Enabled: false
-Layout/AlignParameters:
+Layout/ParameterAlignment:
   Description: Align the parameters of a method call if they span more than one line.
   Enabled: true
   EnforcedStyle: with_first_parameter
@@ -262,14 +260,14 @@ Style/WhenThen:
   Description: Use when x then ... for one-line cases.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#one-line-cases
   Enabled: false
-Layout/TrailingBlankLines:
+Layout/TrailingEmptyLines:
   Description: 'Checks trailing blank lines and final newline.'
   StyleGuide: '#newline-eof'
   Enabled: false
 Lint/EachWithObjectArgument:
   Description: Check for immutable argument given to each_with_object.
   Enabled: true
-Lint/HandleExceptions:
+Lint/SuppressedException:
   Description: Don't suppress exception.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#dont-hide-exceptions
   Enabled: true
@@ -308,7 +306,7 @@ Layout/MultilineOperationIndentation:
   EnforcedStyle: indented
   IndentationWidth: 4
   Enabled: false
-Metrics/LineLength:
+Layout/LineLength:
   Max: 150
 Metrics/BlockLength:
   Exclude:
@@ -318,16 +316,16 @@ Metrics/BlockLength:
 Layout/CaseIndentation:
   EnforcedStyle: case
   IndentOneStep: true
-Layout/IndentFirstArrayElement:
+Layout/FirstArrayElementIndentation:
   IndentationWidth: 4
-Layout/IndentFirstHashElement:
+Layout/FirstHashElementIndentation:
   IndentationWidth: 4
-Layout/IndentFirstArgument:
+Layout/FirstArgumentIndentation:
   IndentationWidth: 4
 Style/FrozenStringLiteralComment:
   Enabled: true
 
-Layout/AlignHash:
+Layout/HashAlignment:
   Description: >-
     Align the elements of a hash literal if they span more than
     one line.

data/.ruby-version

@@ -1 +1 @@
-2.5.1
+2.6.3

data/Gemfile.lock

@@ -1,88 +1,84 @@
 PATH
   remote: .
   specs:
-    acts-as-taggable-on-mongoid (6.0.1.5)
-      activesupport (~> 4.2)
-      mongoid (>= 5.2, <= 7.0.2)
+    acts-as-taggable-on-mongoid (6.1.1.7)
+      activesupport (>= 5.0)
+      mongoid (>= 6.1.1, <= 7.0.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (4.2.11.1)
-      activesupport (= 4.2.11.1)
-      builder (~> 3.1)
-    activesupport (4.2.11.1)
+    activemodel (5.0.0)
+      activesupport (= 5.0.0)
+    activesupport (5.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
       minitest (~> 5.1)
-      thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.0)
     axiom-types (0.1.1)
       descendants_tracker (~> 0.0.4)
       ice_nine (~> 0.11.0)
       thread_safe (~> 0.3, >= 0.3.1)
-    brakeman (4.5.0)
-    bson (4.4.2)
-    builder (3.2.3)
-    code_analyzer (0.4.8)
+    brakeman (4.7.2)
+    bson (4.7.1)
+    code_analyzer (0.5.1)
       sexp_processor
     codeclimate-engine-rb (0.4.1)
       virtus (~> 1.0)
-    codecov (0.1.14)
+    codecov (0.1.16)
       json
       simplecov
       url
     coercible (1.0.0)
       descendants_tracker (~> 0.0.1)
     colorize (0.8.1)
-    concurrent-ruby (1.1.5)
-    cornucopia (0.1.55)
-      activesupport (< 5.0)
-    database_cleaner (1.7.0)
+    concurrent-ruby (1.1.6)
+    cornucopia (0.1.56)
+      activesupport (> 4.0, < 6.0)
+    database_cleaner (1.8.2)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.3)
-    docile (1.3.1)
+    docile (1.3.2)
     equalizer (0.0.11)
     erubis (2.7.0)
-    faraday (0.15.4)
+    faraday (1.0.0)
       multipart-post (>= 1.2, < 3)
-    fasterer (0.5.1)
+    fasterer (0.8.2)
       colorize (~> 0.7)
-      ruby_parser (>= 3.13.0)
-    gem-release (2.0.1)
-    gitlab (4.11.0)
+      ruby_parser (>= 3.14.1)
+    gem-release (2.1.1)
+    gitlab (4.13.1)
       httparty (~> 0.14, >= 0.14.0)
       terminal-table (~> 1.5, >= 1.5.1)
-    httparty (0.17.0)
+    httparty (0.17.3)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
     i18n (0.9.5)
       concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
-    jaro_winkler (1.5.2)
-    json (2.2.0)
+    jaro_winkler (1.5.4)
+    json (2.3.0)
     kwalify (0.7.2)
-    mime-types (3.2.2)
+    mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2019.0331)
-    minitest (5.11.3)
-    mongo (2.8.0)
+    mime-types-data (3.2019.1009)
+    minitest (5.14.0)
+    mongo (2.11.3)
       bson (>= 4.4.2, < 5.0.0)
-    mongoid (5.4.0)
-      activemodel (~> 4.0)
-      mongo (>= 2.5.1, < 3.0.0)
-      origin (~> 2.3)
-      tzinfo (>= 0.3.37)
+    mongoid (6.1.1)
+      activemodel (~> 5.0)
+      mongo (>= 2.4.1, < 3.0.0)
     multi_xml (0.6.0)
-    multipart-post (2.0.0)
-    octokit (4.14.0)
+    multipart-post (2.1.1)
+    octokit (4.16.0)
+      faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
-    origin (2.3.1)
-    parallel (1.17.0)
-    parser (2.6.3.0)
+    parallel (1.19.1)
+    parser (2.7.0.2)
       ast (~> 2.4.0)
     pronto (0.10.0)
       gitlab (~> 4.0, >= 4.0.0)
@@ -109,61 +105,60 @@ GEM
       pronto (~> 0.10.0)
       rubocop (~> 0.50, >= 0.49.1)
     psych (3.1.0)
-    public_suffix (3.0.3)
-    rails_best_practices (1.19.4)
+    public_suffix (4.0.3)
+    rails_best_practices (1.19.5)
       activesupport
-      code_analyzer (>= 0.4.8)
+      code_analyzer (>= 0.5.1)
       erubis
       i18n
       json
-      require_all (~> 2.0)
+      require_all (~> 3.0)
       ruby-progressbar
     rainbow (3.0.0)
-    rake (12.3.2)
-    reek (5.3.2)
+    rake (13.0.1)
+    reek (5.6.0)
       codeclimate-engine-rb (~> 0.4.0)
       kwalify (~> 0.7.0)
-      parser (>= 2.5.0.0, < 2.7, != 2.5.1.1)
+      parser (>= 2.5.0.0, < 2.8, != 2.5.1.1)
       psych (~> 3.1.0)
       rainbow (>= 2.0, < 4.0)
-    require_all (2.0.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.3)
+    require_all (3.0.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (0.68.1)
+    rubocop (0.78.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
+      parser (>= 2.6)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.6)
-    rubocop-performance (1.2.0)
-      rubocop (>= 0.68.0)
-    ruby-progressbar (1.10.0)
-    ruby_parser (3.13.1)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-performance (1.5.2)
+      rubocop (>= 0.71.0)
+    ruby-progressbar (1.10.1)
+    ruby_parser (3.14.2)
       sexp_processor (~> 4.9)
-    rugged (0.28.1)
-    sawyer (0.8.1)
-      addressable (>= 2.3.5, < 2.6)
-      faraday (~> 0.8, < 1.0)
-    sexp_processor (4.12.0)
-    simplecov (0.16.1)
+    rugged (0.28.4.1)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
+    sexp_processor (4.14.1)
+    simplecov (0.18.1)
       docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
+      simplecov-html (~> 0.11.0)
+    simplecov-html (0.11.0)
     simplecov-rcov (0.2.3)
       simplecov (>= 0.4.1)
     terminal-table (1.8.0)
@@ -171,9 +166,9 @@ GEM
     thor (0.20.3)
     thread_safe (0.3.6)
     timecop (0.9.1)
-    tzinfo (1.2.5)
+    tzinfo (1.2.6)
       thread_safe (~> 0.1)
-    unicode-display_width (1.5.0)
+    unicode-display_width (1.6.1)
     url (0.3.2)
     virtus (1.0.5)
       axiom-types (~> 0.1)
@@ -186,7 +181,6 @@ PLATFORMS
 
 DEPENDENCIES
   acts-as-taggable-on-mongoid!
-  bundler (~> 1.16)
   codecov (~> 0.1.0, ~> 0.1)
   cornucopia
   database_cleaner
@@ -198,7 +192,7 @@ DEPENDENCIES
   pronto-rails_best_practices
   pronto-reek
   pronto-rubocop
-  rake (~> 12.3)
+  rake (~> 13.0)
   rspec (~> 3.0)
   rspec_junit_formatter (~> 0.4.1)
   rubocop
@@ -208,4 +202,4 @@ DEPENDENCIES
   timecop
 
 BUNDLED WITH
-   1.17.1
+   2.1.4

data/README.md

@@ -52,6 +52,13 @@ Or install it yourself as:
   **NOTE**: Unlike the `ActsAsTaggableOn` gem, I group Tags by context.  Tags with the same
   name for different contexts keep separate counts and are considered different Tags.
   It is simpler to combine Tags and their counts by name then it is to split them out.
+* **Tagger** - A database object which is given credit for creating a Tagging.  This
+  object is an external model from this gem.  Tagger objects can be specified
+  as being a Tagger using the `acts_as_tagger` method which allows a
+  Tagger object to `tag` Taggable objects.
+* **Owner** - A database object which is given ownership of a Tag object.
+  This object is an external model from this gem.  By default when Tags
+  are created, the owner of a Tag is the same as the Tagger for the Tagging.
 
 The database structure is:
   ```
@@ -559,7 +566,7 @@ ActsAsTaggableOnMongoid.default_parser = MyParser
 @user.tag_list # => ["east", "south"]
 ```
 
-### ~~Tag Ownership~~ Not implimented yet
+### Tag Ownership
 
 Tags can have owners:
 
@@ -577,45 +584,97 @@ end
 @some_user.owned_tags
 Photo.tagged_with("paris", :on => :locations, :owned_by => @some_user)
 @some_photo.locations_from(@some_user) # => ["paris", "normandy"]
-@some_photo.owner_tags_on(@some_user, :locations) # => [#<ActsAsTaggableOnMongoid::Models::Tag id: 1, name: "paris">...]
-@some_photo.owner_tags_on(nil, :locations) # => Ownerships equivalent to saying @some_photo.locations
+@some_photo.tagger_location_lists[@some_user] # => [#<ActsAsTaggableOnMongoid::Models::Tag id: 1, name: "paris">...]
+@some_photo.tagger_location_lists[nil] # => Ownerships equivalent to saying @some_photo.locations
 @some_user.tag(@some_photo, :with => "paris, normandy", :on => :locations, :skip_save => true) #won't save @some_photo object
 ```
 
 #### Working with Owned Tags
-Note that `tag_list` only returns tags whose taggings do not have an owner. Continuing from the above example:
+Note that by default `tag_list` only returns tags whose taggings do not
+have an owner. Continuing from the above example:
 ```ruby
 @some_photo.tag_list # => []
 ```
-To retrieve all tags of an object (regardless of ownership) or if only one owner can tag the object, use `all_tags_list`.
+To retrieve all tags of an object (regardless of ownership) or if only
+one owner can tag the object, you can use `all_tags_list`.
 
-##### Adding owned tags
-Note that **owned tags** are added all at once, in the form of ***comma seperated tags*** in string.
-Also, when you try to add **owned tags** again, it simply overwrites the previous set of **owned tags**.
-So to append tags in previously existing **owned tags** list, go as follows:
+Tags are stored in a Hash grouped by `Tagger`.  You can access this list
+using `tagger_<tag_type>_lists`.  This allows you to directly access and
+use the `TagList` for any owner just like you would the `<tag_type>_list`
+methods.
+
+Examples:
 ```ruby
-def add_owned_tag
-    @some_item = Item.find(params[:id])
-    owned_tag_list = @some_item.all_tags_list - @some_item.tag_list
-    owned_tag_list += [(params[:tag])]
-    @tag_owner.tag(@some_item, :with => stringify(owned_tag_list), :on => :tags)
-    @some_item.save
-end
+tag_lists = @some_photo.tagger_location_lists
+tag_lists.keys # => [@some_user]
+
+# Add tags for @some_user
+tag_lists[@some_user].add "berlin, london", parse: true
+# Remove tags for @some_user
+tag_lists[@some_user].remove "paris"
+# Set the list for @some_user (replacing existing tags)
+tag_lists[@some_user] = "new york, chicago, brussels, rome"
+
+# Add tags for a new owner:
+tag_lists[@other_user] = "moscow, bejing, tokyo"
+```
+#### Owned Tags and defaults
+
+Owned Tags can be difficult to work with having to manage owners
+manually.  To ease that process, I have added the concept of defaults
+to use when working with Owned tags.
+
+When a tag is defined, you can also define default behavior when
+creating the tag and accessing it, simplifying using the tag in
+everyday access.
+
+Options:
+  * tagger: true - Simply defines that a Tag definition supports
+    the concept of Taggers and allows setting the Tagger for a list.
+  * tagger: { default_tagger: :method_name} - This allows you to
+    specify that when a Tagging is created on a Taggable object
+    that the Taggable object will supply the default tagger using
+    the indicated method.
+  * tagger: { tag_list_uses_default_tagger: true } - A
+    shortcut/syntax sugar to treat `<tag_type>_list` to return
+    the tags for the `default_tagger` instead of no taggers
 
-def stringify(tag_list)
-    tag_list.inject('') { |memo, tag| memo += (tag + ',') }[0..-1]
-end
-```
-##### Removing owned tags
-Similarly as above, removing will be as follows:
 ```ruby
-def remove_owned_tag
-    @some_item = Item.find(params[:id])
-    owned_tag_list = @some_item.all_tags_list - @some_item.tag_list
-    owned_tag_list -= [(params[:tag])]
-    @tag_owner.tag(@some_item, :with => stringify(owned_tag_list), :on => :tags)
-    @some_item.save
+class Car
+  acts_as_taggable_on tagger: { default_tagger: :owner, tag_list_uses_default_tagger: true }
+
+  belongs_to :owner, class_name: "User"
 end
+
+class User
+  acts_as_tagger
+
+  has_many :cars
+end
+
+car = @some_user.cars.first
+car.tag_list = "antique, warrantied, registered"
+car.tag_lists[car.owner] # => ["antique", "warrantied", "registerd"]
+car.tag_lists[nil] # => []
+
+car.tag_lists[@potential_buyer] = ["inspected", "test drove", "good value"]
+car.tagger_tag_list(@potential_buyer) # => ["inspected", "test drove", "good value"]
+
+all_list = car.all_tag_list # => ["antique", "warrantied", "registerd", "inspected", "test drove", "good value"]
+all_list.tagger # => @some_user
+
+# Changing `all_list` does NOT affect/change the tags on `car`
+# Changing other lists will:
+all_list.remove "warrantied", "test drove"
+car.tag_lists[car.owner] # => ["antique", "warrantied", "registerd"]
+car.tagger_tag_list(@potential_buyer) # => ["inspected", "test drove", "good value"]
+car.all_tag_list # => ["antique", "warrantied", "registerd", "inspected", "test drove", "good value"]
+
+car.tag_lists[car.owner].add "deposit"
+car.tagger_tag_list(@potential_buyer).remove "good value"
+car.tag_lists[car.owner] # => ["antique", "warrantied", "registerd", "deposit"]
+car.tagger_tag_list(@potential_buyer) # => ["inspected", "test drove"]
+car.all_tag_list # => ["antique", "warrantied", "registerd", "deposit", "inspected", "test drove"]
 ```
 
 ### Dirty objects
@@ -634,6 +693,21 @@ end
 @bobby.skill_list_change.should == ["jogging, diving", ["swimming"]]
 ```
 
+If the object allows for Taggers, there could be multiple Taggers each
+with their own changes.  In this case, the changes (and corresponding
+was values) will be hashes of the Tagger and the tag lists.
+
+```ruby
+@bobby = User.find_by_name("Bobby")
+@bobby.skill_list_from(@teacher).add "attentive, assertive, gold star", parse: true
+@bobby.skill_list_from(@parent).add "forger, standing in corner, truant", parse: true
+
+@bobby.skill_list_change
+# => [ {},
+# =>   { @teacher => ["attentive", "assertive", "gold star"],
+# =>     @parent => ["forger", "standing in corner", "truant"] } ]
+```
+
 ### ~~Tag cloud calculations~~ Not implimented yet
 
 To construct tag clouds, the frequency of each tag needs to be calculated.