minimal_tags 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e2b4c5c52cdbf5bea63ece71f5b175352e483f3b
-  data.tar.gz: 41fad32774779ac38368d2afbbd1db8e9bde5237
+  metadata.gz: eeffa05e90f3cba0710036ad177d58cb8e512c57
+  data.tar.gz: 4a4fc394035d3c25dac9281b9cabb7d6df01366b
 SHA512:
-  metadata.gz: dfefab0bb1683ed4fd3ef688a32994bec272caf17df0184b0521bfdbe770d6457cd68f3bd300b8e4676749ebee31a22781906ac2df0de5f7b92700862d4b42e1
-  data.tar.gz: f035b615d24082b5d76ef8b5e3df7a545d94b8b5f5875cec52bb97ad48b215ae3ee4b1c5a844c07a4ab9808889529145fe18a1831008ce2590f671ded795961f
+  metadata.gz: 61300358c14afa8950b008f5199aa8263c75e0d11a970efa5da4e1a8c60e8e2d0d97a3bca0ba77dcefea5137b401bfd0e4bd3afe349bb9ef09aa015382a1f7d4
+  data.tar.gz: e16c5cf443078a005cfec088695e2d99784a871a24640f8eedc2a25bbbd2e5713d411445f8d1f7a9d3edc20dab9370e52e9bf130e02b98b9be01b52a0db52685

data/.gitignore

@@ -1,6 +1,6 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
+**/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/

data/.travis.yml

@@ -1,12 +1,14 @@
 language: ruby
+cache: bundler
 rvm:
-  - 2.1.0
   - 2.2.3
   - 2.3.0
 gemfile:
   - gemfiles/activerecord_41.gemfile
   - gemfiles/activerecord_42.gemfile
   - gemfiles/activerecord_50.gemfile
+  - gemfiles/mongoid_5.gemfile
+  - gemfiles/sequel_4.gemfile
 services:
   - mongodb
   - postgresql
@@ -17,6 +19,3 @@ before_script:
 addons:
   code_climate:
     repo_token: 3c954617ba40beceb056cc73b82e00a6dc1fa2193cda386dc6c2128bdd61a804
-matrix:
-  allow_failures:
-    - gemfile: gemfiles/activerecord_50.gemfile

data/README.md

@@ -36,6 +36,28 @@ end
 
 ```
 
+### Sequel
+
+Add the following migration for each tag field you want.
+
+```ruby
+Sequel.migration do
+  change do
+    add_column :posts, :tags, 'text[]', default: [], null: false
+    add_index :posts, :tags, type: :gin
+  end
+end
+
+```
+
+Also enable the `pg_array` and `pg_array_ops` extensions:
+
+```ruby
+DB = Sequel.connect('postgres://...')
+DB.extension :pg_array
+Sequel.extension :pg_array_ops
+```
+
 ## Usage
 
 Start by including the `MinimalTags` module and define your tag fields

data/gemfiles/mongoid_5.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'mongoid', '>= 5.0.0', '<= 6.0.0'
+
+gemspec path: '../'

data/gemfiles/sequel_4.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'sequel', '>= 4.0.0', '<= 6.0.0'
+
+gemspec path: '../'

data/gemfiles/sequel_4.gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: ../
+  specs:
+    minimal_tags (0.2.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    codeclimate-test-reporter (0.6.0)
+      simplecov (>= 0.7.1, < 1.0.0)
+    docile (1.1.5)
+    json (1.8.3)
+    minitest (5.9.0)
+    pg (0.18.4)
+    rake (10.5.0)
+    sequel (4.36.0)
+    simplecov (0.12.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    yard (0.9.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.10)
+  codeclimate-test-reporter
+  minimal_tags!
+  minitest
+  pg
+  rake (~> 10.0)
+  sequel (>= 4.0.0, <= 6.0.0)
+  yard
+
+BUNDLED WITH
+   1.12.5

data/lib/minimal_tags/persistence/activerecord.rb

@@ -11,16 +11,16 @@ module MinimalTags
       # normalization on save.
       #
       # @example
-      #   class Posts < ActiveRecord::Base
+      #   class Post < ActiveRecord::Base
       #     include MinimalTags
       #
       #     tag_field :tags
       #   end
       #
-      #   doc = Posts.create(tags: ['hello world', 'this is a test']).tags
+      #   doc = Post.create(tags: ['hello world', 'this is a test']).tags
       #   # => ['hello-world', 'this-is-a-test']
       #
-      #   doc == Posts.any_tags(['HELLO WORLD']).first
+      #   doc == Post.any_tags(['HELLO WORLD']).first
       #   # => true
       #
       # @param [String] field_name The field name to use in mongo and searching methods

data/lib/minimal_tags/persistence/mongoid.rb

@@ -13,17 +13,17 @@ module MinimalTags
       # normalization on save.
       #
       # @example
-      #   class Posts
+      #   class Post
       #     include Mongoid::Document
       #     include MinimalTags
       #
       #     tag_field :tags
       #   end
       #
-      #   doc = Posts.create(tags: ['hello world', 'this is a test']).tags
+      #   doc = Post.create(tags: ['hello world', 'this is a test']).tags
       #   # => ['hello-world', 'this-is-a-test']
       #
-      #   doc == Posts.any_tags(['HELLO WORLD']).first
+      #   doc == Post.any_tags(['HELLO WORLD']).first
       #   # => true
       #
       # @param [String] field_name The field name to use in mongo and searching methods

data/lib/minimal_tags/persistence/sequel.rb

@@ -0,0 +1,55 @@
+module MinimalTags
+  module Persistence
+    module Sequel
+      TAG_SEARCH_TYPES = {
+        all: :contains,
+        any: :overlaps
+      }
+
+      TAG_PREFIX_TYPES = {
+        where: '',
+        exclude: 'without_'
+      }
+
+      ##
+      # Creates a tag field, index, search methods and a callback for tag
+      # normalization on save.
+      #
+      # @example
+      #   class Post < Sequel::Model
+      #     include MinimalTags
+      #
+      #     tag_field :tags
+      #   end
+      #
+      #   doc = Post.create(tags: ['hello world', 'this is a test']).tags
+      #   # => ['hello-world', 'this-is-a-test']
+      #
+      #   doc == Post.any_tags(['HELLO WORLD']).first
+      #   # => true
+      #
+      # @param [String] field_name The field name to use in mongo and searching methods
+      # @param [Object] formatter The formatter to use, overriding the default
+      def tag_field(field_name, formatter: MinimalTags.default_formatter)
+        # Create the scopes for searching tags
+        TAG_SEARCH_TYPES.each do |prefix, operator|
+          TAG_PREFIX_TYPES.each do |method, without_prefix|
+            define_singleton_method "#{without_prefix}#{prefix}_#{field_name}" do |tags|
+              formatted_tags = formatter.normalize(tags)
+              query = ::Sequel.pg_array_op(field_name).send(operator, formatted_tags)
+              send(method, query)
+            end
+          end
+        end
+
+        tag_fields << field_name
+
+        # # Normalize tags on save
+        before_save do |*args|
+          tags = send(field_name) || []
+          send("#{field_name}=", formatter.normalize(tags))
+        end
+      end
+    end
+  end
+end

data/lib/minimal_tags/simple_formatter.rb

@@ -1,6 +1,7 @@
 module MinimalTags
-  # A very simple tag formatter using ActiveSupport's parameterize.
+  # A very simple tag formatter.
   # You should create your own rather than using this.
+  # The Stringex gem works well - https://github.com/rsl/stringex
   class SimpleFormatter
     ##
     # Returns an array of normalized tags
@@ -9,7 +10,7 @@ module MinimalTags
     #
     # @return [Array] Unique, parameterized tags
     def normalize(tags)
-      tags.map(&:parameterize).uniq
+      tags.map { |tag| tag.downcase.gsub(/\s/, '-') }.uniq
     end
   end
 end

data/lib/minimal_tags/version.rb

@@ -1,3 +1,3 @@
 module MinimalTags
-  VERSION = '0.2.5'
+  VERSION = '0.2.6'
 end

data/lib/minimal_tags.rb

@@ -15,6 +15,10 @@ module MinimalTags
       elsif ancestors.include?('ActiveRecord::Base')
         require 'minimal_tags/persistence/activerecord'
         base.send :extend, Persistence::Activerecord
+      elsif ancestors.include?('Sequel::Model')
+        require 'minimal_tags/persistence/sequel'
+        base.plugin :hook_class_methods
+        base.send :extend, Persistence::Sequel
       end
     end
 

data/minimal_tags.gemspec

@@ -18,8 +18,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'mongoid', '>= 5.0.0', '<= 6.0.0'
-  spec.add_development_dependency 'activerecord', '>= 4.0.0', '<= 6.0.0'
   spec.add_development_dependency 'pg'
 
   spec.add_development_dependency 'bundler', '~> 1.10'

metadata

@@ -1,55 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: minimal_tags
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - harrisbaird
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-10 00:00:00.000000000 Z
+date: 2016-07-21 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: mongoid
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.0.0
-    - - "<="
-      - !ruby/object:Gem::Version
-        version: 6.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.0.0
-    - - "<="
-      - !ruby/object:Gem::Version
-        version: 6.0.0
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.0.0
-    - - "<="
-      - !ruby/object:Gem::Version
-        version: 6.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.0.0
-    - - "<="
-      - !ruby/object:Gem::Version
-        version: 6.0.0
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -149,9 +109,13 @@ files:
 - gemfiles/activerecord_41.gemfile
 - gemfiles/activerecord_42.gemfile
 - gemfiles/activerecord_50.gemfile
+- gemfiles/mongoid_5.gemfile
+- gemfiles/sequel_4.gemfile
+- gemfiles/sequel_4.gemfile.lock
 - lib/minimal_tags.rb
 - lib/minimal_tags/persistence/activerecord.rb
 - lib/minimal_tags/persistence/mongoid.rb
+- lib/minimal_tags/persistence/sequel.rb
 - lib/minimal_tags/simple_formatter.rb
 - lib/minimal_tags/version.rb
 - minimal_tags.gemspec