gutentag 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e38980a4454dabe309f3c203ddd7b918f82c5193
-  data.tar.gz: 8b50af89daa6b099ae1cca584478758d11ab6b0c
+  metadata.gz: a26cb66caf12d398610c04fd395478ad28b1274d
+  data.tar.gz: 14ee875c010f87bb3f2fafe5e4bc4076210ae7a8
 SHA512:
-  metadata.gz: 31686ed82181198d188ea9e6f323b3e47e9dbb69e53d9458a2d1adbcbd75d17cc2baf6a563428caabe9dcca0552c22b1efb785e5834312baadefa59f2eeb9a4c
-  data.tar.gz: d9c469b2df3bc48d991700f0e062aa626efeca3c2d15fd813f0f108705ad471d4d833814fbf61af29d577a276e1936cc418746c8e37ce19e448bbfd12a51978c
+  metadata.gz: 8b6c6f02542b419644cdc30e07d776227a98aef5479528d7aa80be05fa45757fc7f6eaeacd298a64df20d72cae62b63bd9e3846d1e460a13a871faabe8c9007a
+  data.tar.gz: 6d58adf70948425b4dacb24284392bbd9faf8b84c5108fffb15b042e2edd0277cfb77d78675c4c23aefa624dc3d7e401405862534d8d6f8ab34d160c8c62ce58

data/README.md

@@ -13,6 +13,7 @@ This was built partly as a proof-of-concept, and partly to see how a tagging gem
 * [Usage](#usage)
 * [Installation](#installation)
 * [Upgrading](#upgrading)
+* [Configuration](#configuration)
 * [Contribution](#contribution)
 * [Licence](#licence)
 
@@ -68,7 +69,7 @@ Article.tagged_with(:ids => [tag_a.id, tag_b.id], :match => :all)
 Get it into your Gemfile - and don't forget the version constraint!
 
 ```Ruby
-gem 'gutentag', '~> 1.0.0'
+gem 'gutentag', '~> 1.1.0'
 ```
 
 Next: your tags get persisted to your database, so let's import and run the migrations to get the tables set up:
@@ -105,6 +106,12 @@ add_index :gutentag_tags, :taggings_count
 
 <h2 id="upgrading">Upgrading</h2>
 
+### 1.1.0
+
+No breaking changes.
+
+Thanks to [Robin](https://github.com/rmehner), Gutentag::Tag#name will now validate default database column lengths ([#41](https://github.com/pat/gutentag/pull/41)).
+
 ### 1.0.0
 
 Behaviour that was deprecated in 0.9.0 (`has_many_tags`, `tagged_with` arguments) have now been removed.
@@ -139,6 +146,40 @@ rename_table :tags,     :gutentag_tags
 rename_table :taggings, :gutentag_taggings
 ```
 
+<h2 id="configuration">Configuration</h2>
+
+Gutentag tries to take a convention-over-configuration approach, while also striving to be modular enough to allow changes to behaviour in certain cases.
+
+### Tag validations
+
+The default validations on `Gutentag::Tag` are:
+
+* presence of the tag name.
+* case-insensitive uniqueness of the tag name.
+* maximum length of the tag name (if the column has a limit).
+
+You can view the logic for this in [`Gutentag::TagValidations`](lib/gutentag/tag_validations.rb), and you can set an alternative if you wish:
+
+```ruby
+Gutentag.tag_validations = CustomTagValidations
+```
+
+The supplied value must respond to `call`, and the argument supplied is the model.
+
+### Tag normalisation
+
+Tag normalisation is used to convert supplied tag values consistently into string tag names. [The default](lib/gutentag.rb#L15) is to convert the value into a string, and then to lower-case.
+
+If you want to do something different, provide an object that responds to call and accepts a single value to `Gutentag.normaliser`:
+
+```ruby
+Gutentag.normaliser = lambda { |value| value.to_s.upcase }
+```
+
+### Case-sensitive tags
+
+Gutentag ignores case by default, but can be customised to be case-sensitive by supplying your own validations and normaliser, as outlined by [Robin Mehner](https://github.com/rmehner) in [issue 42](https://github.com/pat/gutentag/issues/42). Further changes may be required for your schema though, depending on your database.
+
 <h2 id="contribution">Contribution</h2>
 
 Please note that this project now has a [Contributor Code of Conduct](http://contributor-covenant.org/version/1/0/0/). By participating in this project you agree to abide by its terms.

data/gutentag.gemspec

@@ -3,7 +3,7 @@
 
 Gem::Specification.new do |s|
   s.name        = "gutentag"
-  s.version     = "1.0.0"
+  s.version     = "1.1.0"
   s.authors     = ["Pat Allan"]
   s.email       = ["pat@freelancing-gods.com"]
   s.homepage    = "https://github.com/pat/gutentag"

data/lib/gutentag/tag_validations.rb

@@ -13,6 +13,9 @@ class Gutentag::TagValidations
     klass.validates :name,
       :presence   => true,
       :uniqueness => {:case_sensitive => false}
+
+    limit = klass.columns_hash["name"].limit
+    klass.validates_length_of :name, :maximum => limit if limit.present?
   end
 
   private

data/spec/models/gutentag/tag_spec.rb

@@ -63,5 +63,22 @@ describe Gutentag::Tag, :type => :model do
       tag = Gutentag::Tag.create(:name => "Pancakes")
       expect(tag.errors[:name].length).to eq(1)
     end
+
+    if ENV["DATABASE"] == "mysql" || (
+      Gem::Version.new(Rails.version) < Gem::Version.new("4.2.0")
+    )
+      # When using MySQL or Rails before 4.2, string columns convert to
+      # VARCHAR(255), therefore the column has a limit of 255, even though we
+      # did not specify a limit
+      it "validates the length of the name" do
+        tag = Gutentag::Tag.create(:name => "a" * 256)
+        expect(tag.errors[:name].length).to eq(1)
+      end
+    else
+      it "does not validate the length if the column has no limit" do
+        tag = Gutentag::Tag.create(:name => "a" * 256)
+        expect(tag.errors[:name].length).to eq(0)
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gutentag
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Pat Allan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-29 00:00:00.000000000 Z
+date: 2017-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -174,7 +174,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Good Tags