metka 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 960a0b262fa5e1dc7a4a08baf844f4f12063696133527f0ef201a4414ee498c0
+  data.tar.gz: 2792d8b84d0ebf6c9aa197c3bbbe8d6b257f522493a2b770887105cd0d6b539d
+SHA512:
+  metadata.gz: 4b47eb9c9b7e64609b0933b02e5704aa8e5dd5cca5ca1a9c796625942fed6b67551574cb6fe3c45190954ce8bfb56ae40bb125659751d55b5ef8f780a35beb0d
+  data.tar.gz: fe1b4c69679173d7f8c639f3c060722c617f39f537dba1253ff1f9cd70e26a44028e8ae6676d440c2b9165691162f907a0cf4e546510c8e37194db13c59adb44

data/.github/workflows/continuous-integration-workflow.yml

@@ -0,0 +1,11 @@
+name: CI
+# This workflow is triggered on pushes to the repository.
+on: [push]
+
+jobs:
+  build:
+    name: RSpec
+    # This job runs on Linux
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/spec/tmp/
+
+# rspec failure tracking
+.rspec_status
+spec/debug.log
+
+spec/dummy/log/test.log
+spec/dummy/log/development.log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,28 @@
+inherit_gem:
+  jetrockets-standard: config/gems.yml
+
+AllCops:
+  Exclude:
+    - 'bin/*'
+    - 'tmp/**/*'
+    - 'docs/**/*'
+    - 'Gemfile'
+    - 'vendor/**/*'
+    - 'gemfiles/**/*'
+    - '**/*.md'
+  DisplayCopNames: true
+  TargetRubyVersion: 2.5
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: no_comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: no_comma
+
+Layout/AlignParameters:
+  EnforcedStyle: with_first_parameter
+
+# See https://github.com/rubocop-hq/rubocop/issues/4222
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'spec/**/*'

data/.travis.yml

@@ -0,0 +1,36 @@
+---
+language: ruby
+cache: bundler
+
+dist: trusty
+sudo: false
+
+notifications:
+  email: false
+
+services:
+  - postgresql
+addons:
+  postgresql: "11.2"
+
+before_install:
+  - gem install -v 2.0.2 bundler
+  - sudo apt-get update
+  - sudo apt-get --yes remove postgresql\*
+  - sudo apt-get install -y postgresql-11 postgresql-client-11
+  - sudo cp /etc/postgresql/{9.6,11}/main/pg_hba.conf
+  - sudo service postgresql restart 11
+
+before_script:
+  - gem update --system
+  - psql -c 'CREATE ROLE travis SUPERUSER LOGIN CREATEDB;' -U postgres
+  - ./bin/setup
+
+matrix:
+  include:
+    - rvm: 2.5.1
+      gemfile: gemfiles/rails5.gemfile
+    - rvm: 2.5.5
+      gemfile: gemfiles/rails52.gemfile
+    - rvm: 2.6.2
+      gemfile: gemfiles/rails6.gemfile

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at igor.alexandrov@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in metka.gemspec
+gemspec
+
+local_gemfile = "#{File.dirname(__FILE__)}/Gemfile.local"
+
+if File.exist?(local_gemfile)
+  eval(File.read(local_gemfile)) # rubocop:disable Lint/Eval
+else
+  gem 'activerecord', '~> 5.1.1'
+end

data/Gemfile.lock

@@ -0,0 +1,199 @@
+PATH
+  remote: .
+  specs:
+    metka (1.0.0)
+      dry-configurable
+      rails (~> 5.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.1.7)
+      actionpack (= 5.1.7)
+      nio4r (~> 2.0)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.1.7)
+      actionpack (= 5.1.7)
+      actionview (= 5.1.7)
+      activejob (= 5.1.7)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.1.7)
+      actionview (= 5.1.7)
+      activesupport (= 5.1.7)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.1.7)
+      activesupport (= 5.1.7)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.1.7)
+      activesupport (= 5.1.7)
+      globalid (>= 0.3.6)
+    activemodel (5.1.7)
+      activesupport (= 5.1.7)
+    activerecord (5.1.7)
+      activemodel (= 5.1.7)
+      activesupport (= 5.1.7)
+      arel (~> 8.0)
+    activesupport (5.1.7)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ammeter (1.1.4)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-rails (>= 2.2)
+    arel (8.0.0)
+    ast (2.4.0)
+    builder (3.2.3)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    crass (1.0.5)
+    database_cleaner (1.7.0)
+    diff-lcs (1.3)
+    dry-configurable (0.9.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.4, >= 0.4.7)
+    dry-core (0.4.9)
+      concurrent-ruby (~> 1.0)
+    erubi (1.9.0)
+    faker (2.8.0)
+      i18n (>= 1.6, < 1.8)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.7.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    jetrockets-standard (1.0.4)
+      rubocop-rails (~> 2.3.2)
+      rubocop-rspec (~> 1.35.0)
+      standard (~> 0.1.4)
+    loofah (2.4.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    method_source (0.9.2)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.13.0)
+    nio4r (2.5.2)
+    nokogiri (1.10.7)
+      mini_portile2 (~> 2.4.0)
+    parallel (1.19.1)
+    parser (2.6.5.0)
+      ast (~> 2.4.0)
+    pg (1.1.4)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rack (2.0.7)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (5.1.7)
+      actioncable (= 5.1.7)
+      actionmailer (= 5.1.7)
+      actionpack (= 5.1.7)
+      actionview (= 5.1.7)
+      activejob (= 5.1.7)
+      activemodel (= 5.1.7)
+      activerecord (= 5.1.7)
+      activesupport (= 5.1.7)
+      bundler (>= 1.3.0)
+      railties (= 5.1.7)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (5.1.7)
+      actionpack (= 5.1.7)
+      activesupport (= 5.1.7)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-rails (3.9.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rubocop (0.75.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-performance (1.5.1)
+      rubocop (>= 0.71.0)
+    rubocop-rails (2.3.2)
+      rack (>= 1.1)
+      rubocop (>= 0.72.0)
+    rubocop-rspec (1.35.0)
+      rubocop (>= 0.60.0)
+    ruby-progressbar (1.10.1)
+    sprockets (4.0.0)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    standard (0.1.6)
+      rubocop (~> 0.75.0)
+      rubocop-performance (~> 1.5.0)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    timecop (0.9.1)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.6.0)
+    websocket-driver (0.6.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 5.1.1)
+  ammeter
+  bundler
+  database_cleaner
+  faker
+  jetrockets-standard (~> 1.0.1)
+  metka!
+  pg
+  pry (~> 0.12.2)
+  rake
+  rspec (~> 3.9)
+  rspec-rails (~> 3.9)
+  timecop
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Igor Alexandrov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,259 @@
+[![Build Status](https://travis-ci.org/jetrockets/metka.svg?branch=master)](https://travis-ci.org/jetrockets/metka)
+[![Open Source Helpers](https://www.codetriage.com/jetrockets/metka/badges/users.svg)](https://www.codetriage.com/jetrockets/metka)
+
+# Metka
+
+Rails gem to manage tags with SonggreSQL array columns.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'metka'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install metka
+
+## Tag objects
+
+```ruby
+class Song < ActiveRecord::Base
+  include Metka::Model(column: 'tags')
+  include Metka::Model(column: 'genres')
+end
+
+@Song = Song.new(title: 'Migrate tags in Rails to SonggreSQL')
+@Song.tag_list = 'top, chill'
+@Song.genre_list = 'rock, jazz, pop'
+@Song.save
+```
+
+## Find tagged objects
+
+### .with_all_#{column_name}
+```ruby
+Song.with_all_tags('top')
+=> [#<Song id: 1, title: 'Migrate tags in Rails to SonggreSQL', tags: ['top', 'chill'], genres: ['rock', 'jazz', 'pop']]
+
+Song.with_all_tags('top, 1990')
+=> []
+
+Song.with_all_tags('')
+=> []
+
+Song.with_all_genres('rock')
+=> [#<Song id: 1, title: 'Migrate tags in Rails to SonggreSQL', tags: ['top', 'chill'], genres: ['rock', 'jazz', 'pop']]
+```
+
+### .with_any_#{column_name}
+```ruby
+Song.with_any_tags('chill')
+=> [#<Song id: 1, title: 'Migrate tags in Rails to SonggreSQL', tags: ['top', 'chill'], genres: ['rock', 'jazz', 'pop']]
+
+Song.with_any_tags('chill, 1980')
+=> [#<Song id: 1, title: 'Migrate tags in Rails to SonggreSQL', tags: ['top', 'chill'], genres: ['rock', 'jazz', 'pop']]
+
+Song.with_any_tags('')
+=> []
+
+Song.with_any_genres('rock, rap')
+=> [#<Song id: 1, title: 'Migrate tags in Rails to SonggreSQL', tags: ['top', 'chill'], genres: ['rock', 'jazz', 'pop']]
+```
+### .without_all_#{column_name}
+```ruby
+Song.without_all_tags('top')
+=> []
+
+Song.without_all_tags('top, 1990')
+=> [#<Song id: 1, title: 'Migrate tags in Rails to SonggreSQL', tags: ['top', 'chill'], genres: ['rock', 'jazz', 'pop']]
+
+Song.without_all_tags('')
+=> [#<Song id: 1, title: 'Migrate tags in Rails to SonggreSQL', tags: ['top', 'chill'], genres: ['rock', 'jazz', 'pop']]
+
+Song.without_all_genres('rock, pop')
+=> [#<Song id: 1, title: 'Migrate tags in Rails to SonggreSQL', tags: ['top', 'chill'], genres: ['rock', 'jazz', 'pop']]
+
+Song.without_all_genres('rock')
+=> []
+```
+
+### .without_any_#{column_name}
+```ruby
+Song.without_any_tags('top, 1990')
+=> []
+
+Song.without_any_tags('1990, 1980')
+=> [#<Song id: 1, title: 'Migrate tags in Rails to SonggreSQL', tags: ['top', 'chill'], genres: ['rock', 'jazz', 'pop']]
+
+Song.without_any_genres('rock, pop')
+=> []
+
+Song.without_any_genres('')
+=> [#<Song id: 1, title: 'Migrate tags in Rails to SonggreSQL', tags: ['top', 'chill'], genres: ['rock', 'jazz', 'pop']]
+```
+
+## Custom delimiter
+By default, a comma is used as a delimiter to create tags from a string.
+You can make your own custom separator:
+```ruby
+Metka.config.delimiter = [',', ' ', '\|']
+parsed_data = Metka::GenericParser.instance.call('cool, data|I have')
+parsed_data.to_a
+=>['cool', 'data', 'I', 'have']
+```
+
+## Tags with quote
+```ruby
+parsed_data = Metka::GenericParser.instance.call("'cool, data', code")
+parsed_data.to_a
+=> ['cool, data', 'code']
+```
+
+## Custom parser
+By default we use [generic_parser](lib/metka/generic_parser.rb "generic_parser")
+If you want use your custom parser you can do:
+```ruby
+class Song < ActiveRecord::Base
+  include Metka::Model(column: 'tags', parser: Your::Custom::Parser.instance)
+  include Metka::Model(column: 'genres')
+end
+```
+Custom parser must be a singleton class that has a `.call` method that accepts the tag string
+
+## Tag Cloud Strategies
+
+There are several strategies to get tag statistics
+
+### View Strategy
+
+Data about taggings will be agregated in SQL View. The easiest way to implement but the most slow on SELECT.
+
+```bash
+rails g metka:strategies:view --source-table-name=NAME_OF_TABLE_WITH_TAGS
+```
+
+The code above will generate a migration that creates view to store aggregated data about tag in `NAME_OF_TABLE_WITH_TAGS` table.
+
+Lets take a look at real example. We have a `notes` table with `tags` column.
+
+| Column | Type                | Default                           |
+|--------|---------------------|-----------------------------------|
+| id     | integer             | nextval('notes_id_seq'::regclass) |
+| body   | text                |                                   |
+| tags   | character varying[] | '{}'::character varying[]         |
+
+Now lets generate a migration.
+
+```bash
+rails g metka:strategies:view --source-table-name=notes
+```
+
+The result would be:
+
+```ruby
+# frozen_string_literal: true
+
+class CreateTaggedNotesView < ActiveRecord::Migration[5.0]
+  def up
+    execute <<-SQL
+    CREATE OR REPLACE VIEW tagged_notes AS
+
+    SELECT UNNEST
+      ( tags ) AS tag_name,
+      COUNT ( * ) AS taggings_count
+    FROM
+      notes
+    GROUP BY
+      name;
+    SQL
+  end
+
+  def down
+    execute <<-SQL
+      DROP VIEW tagged_notes;
+    SQL
+  end
+end
+```
+
+Now lets take a look at `tagged_notes` view.
+
+| tag_name | taggings_count |
+|----------|----------------|
+| Ruby     | 124056         |
+| React    | 30632          |
+| Rails    | 28696          |
+| Crystal  | 6566           |
+| Elixir   | 3475           |
+
+Now you can create `TaggedNote` model and work with the view like you usually do with Rails models.
+
+### Materialized View Strategy
+
+Similar to the strategy above, but the view will be Materialized and refreshed with the trigger
+
+```bash
+rails g metka:strategies:materialized_view --source-table-name=NAME_OF_TABLE_WITH_TAGS
+```
+
+The code above will generate a migration that creates view to store aggregated data about tag in `NAME_OF_TABLE_WITH_TAGS` table.
+
+Lets take a look at real example. We have a `notes` table with `tags` column.
+
+| Column | Type                | Default                           |
+|--------|---------------------|-----------------------------------|
+| id     | integer             | nextval('notes_id_seq'::regclass) |
+| body   | text                |                                   |
+| tags   | character varying[] | '{}'::character varying[]         |
+
+Now lets generate a migration.
+
+```bash
+rails g metka:strategies:materialized_view --source-table-name=notes
+```
+
+The migration code you can see [here](spec/dummy/db/migrate/05_create_tagged_materialized_view_Songs_materialized_view.rb "here")
+
+Now lets take a look at `tagged_notes` materialized view.
+
+Now you can create `TaggedNote` model and work with the view like you usually do with Rails models.
+
+### Table Strategy with Triggers
+
+
+
+TBD
+
+## Inspired by
+1. [ActsAsTaggableOn](https://github.com/mbleigh/acts-as-taggable-on)
+2. [ActsAsTaggableArrayOn](https://github.com/tmiyamon/acts-as-taggable-array-on)
+3. [TagColumns](https://github.com/hopsoft/tag_columns)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/metka. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Credits
+![JetRockets](https://jetrockets.pro/jetrockets-icons-black.png)
+Metka is maintained by [JetRockets](http://www.jetrockets.ru).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Metka project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/metka/blob/master/CODE_OF_CONDUCT.md).