interage-query 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 635408157836d195392fe9af6fc25cef12dbc9af290bf9b7e7dca2e31daba904
+  data.tar.gz: 58afcab84392f1a16f296859312195887f479a93cc5ad35d0d827001f3fd8f42
+SHA512:
+  metadata.gz: 37ebb5f4e8cbab5b11a55aea7642b5aff47cd44bd2d00cf57cf5d19e84adb81679c5402443733c2f6acdecae15c8d8b02bdf3f99b1a68e1282c4729782579904
+  data.tar.gz: 61e710399d859b2a5e30400138d9e2899cd7dbf1508e9c7c013a66298a747c79e3dcf46287ac1671bb19fbbf48d41d6881b8f3471f64d6b75f1ab009980e9026

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,4 @@
+--require spec_helper
+--format documentation
+--force-color
+--order rand

data/.rubocop.yml

@@ -0,0 +1,22 @@
+require:
+  - rubocop-rspec
+  - rubocop-performance
+
+Documentation:
+  Enabled: false
+
+Style/EmptyMethod:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/WordArray:
+  Enabled: false
+
+AllCops:
+  TargetRubyVersion: 2.6
+  Exclude:
+    - bin/**/*
+    - vendor/**/*
+    - lib/generators/interage/query/*/templates/**/*.rb

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.2
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  # https://github.com/rubocop-hq/rubocop#quickstart
+  gem 'rubocop', '~> 0.67.2'
+  # https://github.com/backus/rubocop-rspec
+  gem 'rubocop-rspec', '~> 1.32'
+  # https://github.com/rubocop-hq/rubocop-performance/#usage
+  gem 'rubocop-performance', '~> 1.1'
+  # https://github.com/rspec/rspec#install
+  gem 'rspec', '~> 3.8'
+  # https://github.com/pry/pry#installation
+  gem 'pry', '~> 0.12.2'
+  # https://github.com/presidentbeef/brakeman
+  gem 'brakeman', '~> 4.3', '>= 4.3.1', require: false
+  # https://github.com/rails/rails/tree/master/activesupport#download-and-installation
+  gem 'activesupport', '~> 5.2', '>= 5.2.3'
+end

data/Gemfile.lock

@@ -0,0 +1,80 @@
+PATH
+  remote: .
+  specs:
+    interage-query (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ast (2.4.0)
+    brakeman (4.5.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.2)
+    method_source (0.9.2)
+    minitest (5.11.3)
+    parallel (1.17.0)
+    parser (2.6.2.1)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    psych (3.1.0)
+    rainbow (3.0.0)
+    rake (10.5.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.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.67.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    rubocop-performance (1.1.0)
+      rubocop (>= 0.67.0)
+    rubocop-rspec (1.32.0)
+      rubocop (>= 0.60.0)
+    ruby-progressbar (1.10.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 5.2, >= 5.2.3)
+  brakeman (~> 4.3, >= 4.3.1)
+  bundler (~> 2.0)
+  interage-query!
+  pry (~> 0.12.2)
+  rake (~> 10.0)
+  rspec (~> 3.8)
+  rubocop (~> 0.67.2)
+  rubocop-performance (~> 1.1)
+  rubocop-rspec (~> 1.32)
+
+BUNDLED WITH
+   2.0.1

data/README.md

@@ -0,0 +1,40 @@
+# Interage::Query
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'interage-query', '~> 0.1'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install interage-query
+```
+
+## Usage
+
+You can use a Rails generator to create `ApplicationQuery`:
+
+```bash
+rails g interage:query:install
+```
+
+And you can use a Rails generator to create query classes:
+
+
+```bash
+rails g interage:query:create UsersByEmail User
+```
+
+## Contributing
+
+Bug reports and merge requests are welcome on GitLab at https://gitlab.com/[USERNAME]/interage-query.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/brakeman

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'brakeman' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("brakeman", "brakeman")

data/bin/bundle

@@ -0,0 +1,105 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bundle' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "rubygems"
+
+m = Module.new do
+    module_function
+
+  def invoked_as_script?
+    File.expand_path($0) == File.expand_path(__FILE__)
+  end
+
+  def env_var_version
+    ENV["BUNDLER_VERSION"]
+  end
+
+  def cli_arg_version
+    return unless invoked_as_script? # don't want to hijack other binstubs
+    return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
+    bundler_version = nil
+    update_index = nil
+    ARGV.each_with_index do |a, i|
+      if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
+        bundler_version = a
+      end
+      next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
+      bundler_version = $1 || ">= 0.a"
+      update_index = i
+    end
+    bundler_version
+  end
+
+  def gemfile
+    gemfile = ENV["BUNDLE_GEMFILE"]
+    return gemfile if gemfile && !gemfile.empty?
+
+    File.expand_path("../../Gemfile", __FILE__)
+  end
+
+  def lockfile
+    lockfile =
+      case File.basename(gemfile)
+      when "gems.rb" then gemfile.sub(/\.rb$/, gemfile)
+      else "#{gemfile}.lock"
+      end
+    File.expand_path(lockfile)
+  end
+
+  def lockfile_version
+    return unless File.file?(lockfile)
+    lockfile_contents = File.read(lockfile)
+    return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
+    Regexp.last_match(1)
+  end
+
+  def bundler_version
+    @bundler_version ||= begin
+      env_var_version || cli_arg_version ||
+        lockfile_version || "#{Gem::Requirement.default}.a"
+    end
+  end
+
+  def load_bundler!
+    ENV["BUNDLE_GEMFILE"] ||= gemfile
+
+    # must dup string for RG < 1.8 compatibility
+    activate_bundler(bundler_version.dup)
+  end
+
+  def activate_bundler(bundler_version)
+    if Gem::Version.correct?(bundler_version) && Gem::Version.new(bundler_version).release < Gem::Version.new("2.0")
+      bundler_version = "< 2"
+    end
+    gem_error = activation_error_handling do
+      gem "bundler", bundler_version
+    end
+    return if gem_error.nil?
+    require_error = activation_error_handling do
+      require "bundler/version"
+    end
+    return if require_error.nil? && Gem::Requirement.new(bundler_version).satisfied_by?(Gem::Version.new(Bundler::VERSION))
+    warn "Activating bundler (#{bundler_version}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_version}'`"
+    exit 42
+  end
+
+  def activation_error_handling
+    yield
+    nil
+  rescue StandardError, LoadError => e
+    e
+  end
+end
+
+m.load_bundler!
+
+if m.invoked_as_script?
+  load Gem.bin_path("bundler", "bundle")
+end

data/bin/ci

@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+
+set -e
+
+echo -e "\e[1;36m$ bin/brakeman --force-scan \e[0m"
+bin/brakeman --force-scan
+
+echo -e "\e[1;36m$ bin/rubocop \e[0m"
+bin/rubocop
+
+echo -e "\e[1;36m$ bin/rspec \e[0m"
+bin/rspec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "interage/query"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/interage-query.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'interage/query/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'interage-query'
+  spec.version       = Interage::Query::VERSION
+  spec.authors       = ['Walmir Neto']
+  spec.email         = ['owalmirneto@gmail.com']
+
+  spec.summary       = 'Application Query for Interage'
+  spec.description   = 'Classes to encapsulate queries'
+  spec.homepage      = 'https://gitlab.com/interage/patterns/query'
+  spec.licenses      = ['MIT']
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = spec.homepage
+    spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/master/CHANGES"
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |file|
+      file.match(%r{^(test|spec|features)/}) || file.split('.').last == 'gem'
+    end
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/generators/interage/query/create/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails g interage:query:create UsersByPerson User
+
+    This will create:
+        /app/queries/users_by_person_query.rb

data/lib/generators/interage/query/create/create_generator.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Interage
+  module Query
+    module Generators
+      class CreateGenerator < Rails::Generators::NamedBase
+        source_root File.expand_path('templates', __dir__)
+
+        desc 'Generates a query.'
+
+        def initialize(args, *_options)
+          super
+
+          @query_name = args[0].camelize
+          @model_name = args[1].camelize
+        end
+
+        def create_query
+          create_file Rails.root.join("app/queries/#{file_name}_query.rb"),
+                      sample_file.gsub('{{QUERY_NAME}}', query_name)
+                                 .gsub('{{MODEL_NAME}}', model_name)
+        end
+
+        private
+
+        attr_reader :query_name, :model_name
+
+        def sample_file
+          File.read(File.expand_path('templates/sample_query.rb', __dir__))
+        end
+      end
+    end
+  end
+end

data/lib/generators/interage/query/create/templates/sample_query.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class {{QUERY_NAME}}Query < ApplicationQuery
+  def initialize
+    @relation = {{MODEL_NAME}}.order(created_at: :desc)
+  end
+end

data/lib/generators/interage/query/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails g interage:query:install
+
+    This will create:
+        /app/queries/application_query.rb

data/lib/generators/interage/query/install/install_generator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Interage
+  module Query
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      desc 'Generates a application query.'
+
+      def create_application_query
+        copy_file 'application_query.rb', application_query_path
+      end
+
+      private
+
+      def application_query_path
+        Rails.root.join('app/queries/application_query.rb')
+      end
+    end
+  end
+end

data/lib/generators/interage/query/install/templates/application_query.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class ApplicationQuery < ::Interage::ApplicationQuery
+end

data/lib/interage/application_query.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Interage
+  class ApplicationQuery
+    PER_PAGE = 50
+
+    delegate :first, :find_by, :last, :count, :any?, to: :relation
+
+    def all
+      includes.relation
+    end
+
+    def build(attributes = {})
+      all.new(attributes)
+    end
+
+    def find(id)
+      relation.find_by(id: id)
+    end
+
+    def paginate(page = 1)
+      all.page(page).per(PER_PAGE)
+    end
+
+    def by_id(id)
+      @relation = relation.where(id: id) if id.present?
+
+      self
+    end
+
+    def search_ilike_for(colums, term)
+      return self unless term
+
+      params = { t: "%#{term.to_s.downcase}%" }
+      colums = colums.map { |colum| "unaccent(#{colum}) ILIKE unaccent(:t)" }
+      @relation = relation.where(colums.join(' OR '), params)
+
+      self
+    end
+
+    def between_dates(column, start_date, finish_date = nil)
+      start_date = Time.current if start_date.blank?
+      finish_date = start_date if finish_date.blank?
+      range_date =
+        start_date.to_date.beginning_of_day..finish_date.to_date.end_of_day
+
+      @relation = relation.where(column => range_date)
+
+      self
+    end
+
+    def includes
+      self
+    end
+
+    protected
+
+    attr_accessor :relation
+  end
+end

data/lib/interage/query/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Interage
+  module Query
+    VERSION = '0.1.0'
+  end
+end

data/lib/interage/query.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'interage/query/version'
+require 'active_support/core_ext/module'
+
+module Interage
+  module Query
+    class Error < StandardError
+    end
+  end
+
+  autoload :ApplicationQuery, 'interage/application_query'
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: interage-query
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Walmir Neto
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Classes to encapsulate queries
+email:
+- owalmirneto@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/brakeman
+- bin/bundle
+- bin/ci
+- bin/console
+- bin/rspec
+- bin/rubocop
+- bin/setup
+- interage-query.gemspec
+- lib/generators/interage/query/create/USAGE
+- lib/generators/interage/query/create/create_generator.rb
+- lib/generators/interage/query/create/templates/sample_query.rb
+- lib/generators/interage/query/install/USAGE
+- lib/generators/interage/query/install/install_generator.rb
+- lib/generators/interage/query/install/templates/application_query.rb
+- lib/interage/application_query.rb
+- lib/interage/query.rb
+- lib/interage/query/version.rb
+homepage: https://gitlab.com/interage/patterns/query
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://gitlab.com/interage/patterns/query
+  source_code_uri: https://gitlab.com/interage/patterns/query
+  changelog_uri: https://gitlab.com/interage/patterns/query/blob/master/CHANGES
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Application Query for Interage
+test_files: []