tag_columns 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 70fdfc0271ea3299c00a03617d8ac8ab3c1aa922
-  data.tar.gz: 59f0c97926eb432b77ee06449d0c8ae185bc7af9
+  metadata.gz: 916161bd2f1a95730ddd6801964cf49db63031dc
+  data.tar.gz: 841bfffd779bf8bcbeeac455f88cd9e7793f3942
 SHA512:
-  metadata.gz: a6c2a2898846a98c5aa13356866d1cddd709d0a2025799bd3166bcedbdd0c2b92b46756bf4855e22a9a5c040c486fc34d4f25b6c4a212b9e0caef9caca102159
-  data.tar.gz: 2474138516e22364189e4a84339ff80226391ca44be868904a00e6ddb3c03cf28676a7ebfb575761ea76238a79b183c974ae9e76dfec03a4823f6a91de7e7f8c
+  metadata.gz: 4ee1165ec2966aa7899a25a630a6608328b743879ea6fe6bc92ef977b60637feaf44b28252e433621130d023ddb5d815ffa20f9e34c6bda6838fe46152bd2554
+  data.tar.gz: 3efc49aefd5ceeab7989b9aa568e9ce9d6ea16230eedb915109c49fcb1bed47c34f7b73ebe991fcc95d1063ee9b2a9011efbb7b10d605d88dbda0164b7f0e7d2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tag_columns (0.1.1)
+    tag_columns (0.1.2)
       activesupport
 
 GEM

data/README.md

@@ -1,3 +1,56 @@
 # TagColumns
 
-This is a work in progress.
+Fast & simple model tagging using [PostgreSQL's](https://www.postgresql.org/) [Array datatype](https://www.postgresql.org/docs/current/static/arrays.html).
+*Similar to [acts_as_taggable_on](https://github.com/mbleigh/acts-as-taggable-on) but lighter weight with fewer features.*
+
+## Use Cases
+
+Assign categories to your database records.
+
+* Assign multiple groups to user records
+* Assign categories to blog posts et al.
+* etc...
+
+## Quick Start
+
+```ruby
+# Gemfile
+gem "tag_columns"
+```
+
+```ruby
+# db/migrate/TIMESTAMP_add_groups_to_user.rb
+class AddGroupsToUser < ActiveRecord::Migration[5.0]
+  def change
+    add_column :users, :groups, :string, array: true, default: "{}", null: false
+    add_index :users, :groups, using: "gin"
+  end
+end
+```
+
+```ruby
+class User < ApplicationRecord
+  include SelfRenderer
+end
+```
+
+```ruby
+user = User.find(1)
+
+# assigning tags
+user.groups << :reader
+user.groups << :writer
+user.save
+
+# checking tags
+is_writer            = user.has_group?(:writer)
+is_reader_or_writer  = user.has_any_groups?(:reader, :writer)
+is_reader_and_writer = user.has_all_groups?(:reader, :writer)
+
+# finding tagged records
+writers                 = User.with_any_groups(:writer)
+non_writers             = User.without_any_groups(:writer)
+readers_or_writers      = User.with_any_groups(:reader, :writer)
+readers_and_writers     = User.with_all_groups(:reader, :writer)
+non_readers_and_writers = User.without_all_groups(:reader, :writer)
+```

data/Rakefile

@@ -1,2 +1,7 @@
 require "bundler/gem_tasks"
-task :default => :spec
+
+task default: [:test]
+
+task :test do
+  exec "bundle exec pry-test --disable-pry"
+end

data/lib/tag_columns.rb

@@ -36,14 +36,14 @@ module TagColumns
           (values & existing).present?
         end
 
-        alias_method :"has_#{method_name.singularize}?", :"has_any_#{method_name}?"
-
         define_method :"has_all_#{method_name}?" do |*values|
           values = self.class.tag_columns_sanitize_list(values)
           existing = self.class.tag_columns_sanitize_list(self[column_name] || [])
           (values & existing).size == values.size
         end
 
+        alias_method :"has_#{method_name.singularize}?", :"has_all_#{method_name}?"
+
         @tag_columns[column_name] = true
       end
     end

data/lib/tag_columns/version.rb

@@ -1,3 +1,3 @@
 module TagColumns
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tag_columns
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Nathan Hopkins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-13 00:00:00.000000000 Z
+date: 2017-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -119,5 +119,5 @@ rubyforge_project:
 rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: Work in progress
+summary: Fast & simple model tagging using PostgreSQL's Array datatype
 test_files: []