rails_console_toolkit 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d50673e1deb8963c98f22292c95446f83baa29b18bdb7e06199a80f9e5b1388f
-  data.tar.gz: 5834816fa5f8fc3136576ad21d6f1d95c9dfb6bbc35cd2210882bb81d18701ce
+  metadata.gz: 7923cd1b5ca7ce01c1a58372c4d568c348c88f0d351aa4d784eef148328c8700
+  data.tar.gz: ea1aaa9db79ced4baee7b73bb9e7652c059f8ca81a585758628bc2087f2e9afc
 SHA512:
-  metadata.gz: a44ae00ec2915af4452cb40ade632c50142a0661db9fc7b1212189db25740b55ebc3c51df3b4737212d5c8c387ff2f21c703c4940ae793b24fd208085c9c9e89
-  data.tar.gz: 32f281e091aba5e871699efdf40c744723ba0ef205bb1ece9f7aac2c8e1bb22cc66596a773c714a50135eb53bd3a777fe3ef31a9f2c34b6c210051fc940ec854
+  metadata.gz: 9f64a1c43c9571509e3280e8eee86bccf571046e8a426b6b464d8f4f5eedfd2a643e2d96702f3ccc52182f4c4278b9d39b596f55ce0b9999394c281502f4ef53
+  data.tar.gz: 8c1b5186da25dea915ce02f1f3be6e58c32c115d617bd86f934d193245cdf20027928826e74504cc70bc2a6862cc181448bd6fa3dbd0f9b881faa1bae6602fd3

data/.github/workflows/build.yml

@@ -0,0 +1,47 @@
+name: build
+
+on:
+  push:
+    branches:
+      - master
+      - "*/ci-check"
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  rake:
+    name: ${{ matrix.combo.name }}
+    strategy:
+      fail-fast: false
+      matrix:
+        combo:
+          - name: current-ruby
+            ruby: 3.0
+          - name: previous-ruby
+            ruby: 2.7
+          - name: older-ruby
+            ruby: 2.6
+
+    runs-on: 'ubuntu-latest'
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.combo.ruby }}
+          bundler-cache: false
+      - run: bundle lock
+      - uses: actions/cache@v2
+        with:
+          path: ./vendor/bundle
+          key: ${{ runner.os }}-${{ matrix.combo.ruby }}-gems-${{ github.ref }}-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ matrix.combo.ruby }}-gems-${{ github.ref }}
+            ${{ runner.os }}-${{ matrix.combo.ruby }}-gems-master
+            ${{ runner.os }}-${{ matrix.combo.ruby }}-gems-
+      - name: bundle install
+        run: |
+          bundle config path $PWD/vendor/bundle
+          bundle install --jobs 4 --retry 3
+          bundle clean
+      - run: bundle exec rake

data/README.md

@@ -4,7 +4,8 @@
 
 Find records faster, add custom helpers, improve your console life by 100%.
 
-[![CircleCI](https://img.shields.io/circleci/build/github/nebulab/rails_console_toolkit/master?logo=circleci)](https://circleci.com/gh/nebulab/rails_console_toolkit)
+[![Build](https://github.com/nebulab/rails_console_toolkit/workflows/build/badge.svg)](https://github.com/nebulab/rails_console_toolkit/actions?query=workflow%3Abuild)
+
 
 ## Installation
 
@@ -14,13 +15,23 @@ Add this line to your application's Gemfile:
 gem 'rails_console_toolkit'
 ```
 
-And then configure it within an initializer:
+And then generate the initializer:
+
+```
+$ bin/rails generate rails_console_toolkit:install
+```
+
+or write it manually:
 
 ```ruby
 # config/initializers/console.rb
 
 RailsConsoleToolkit.configure do |config|
   # helper definitions go here...
+  #
+  # config.use_pack :aliases
+  # config.use_pack :utils
+  # config.use_pack :solidus if defined? Spree
 end
 ```
 
@@ -123,7 +134,7 @@ end
 # config/initializers/console.rb
 
 RailsConsoleToolkit.configure do |config|
-  config.model_helper 'Spree::Product', as: :product, by: %i[:name, :slug]
+  config.model_helper 'Spree::Product', as: :product, by: %i[name slug]
 end
 ```
 

data/lib/generators/rails_console_toolkit/install/install_generator.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RailsConsoleToolkit
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      def copy_initializer
+        copy_file 'initializer.rb', 'config/initializers/console.rb'
+      end
+    end
+  end
+end

data/lib/generators/rails_console_toolkit/install/templates/initializer.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+RailsConsoleToolkit.configure do |config|
+  # Uncomment to activate a pack:
+  #
+  # config.use_pack :aliases
+  # config.use_pack :utils
+  # config.use_pack :solidus if defined? Spree
+  #
+  # An example of a model-helper:
+  #
+  # config.model_helper 'Product', as: :product, by: %i[name slug]
+end

data/lib/rails_console_toolkit/helpers.rb

@@ -19,19 +19,23 @@ module RailsConsoleToolkit::Helpers
     helper_methods[name.to_sym] = block
   end
 
-  def model_helper(klass, as: nil, by: nil, cached: true)
-    klass = klass.constantize if klass.respond_to? :constantize
-    method_name = as || klass.name.gsub('::', '_').underscore
-    cache_key = method_name
+  def model_helper(klass_name, as: nil, by: nil, cached: true)
+    unless String === klass_name
+      raise TypeError, "The class name is expected to be a String, got #{klass_name.inspect} (#{klass_name.class}) instead."
+    end
+
+    method_name = as || klass_name.gsub('::', '_').underscore
     attribute_names = by || []
 
     record = nil # use the closure as a cache
 
     helper method_name do |key = nil|
+      klass = klass_name.constantize
       record = nil unless cached
 
       if key
         record = nil
+        record = key if klass === key
         record ||= klass.find(key) if Numeric === key
         attribute_names.find { |name| record ||= klass.find_by(name => key) }
       end

data/lib/rails_console_toolkit/solidus.rb

@@ -5,9 +5,12 @@ RailsConsoleToolkit.helper :load_factories do
   Rails::ConsoleMethods.send :include, ::FactoryBot::Syntax::Methods
 end
 
-RailsConsoleToolkit.model_helper Spree::Product, as: :product, by: [:slug, :name]
-RailsConsoleToolkit.model_helper Spree::Variant, as: :variant, by: [:sku]
-RailsConsoleToolkit.model_helper Spree::Taxon, as: :taxon, by: [:permalink]
-RailsConsoleToolkit.model_helper Spree::Order, as: :order, by: [:number]
-RailsConsoleToolkit.model_helper Spree::User, as: :user, by: [:email]
-RailsConsoleToolkit.model_helper Spree::Country, as: :country, by: [:iso, :iso3, :iso_name, :name]
+RailsConsoleToolkit.model_helper "Spree::Product", as: :product, by: [:slug, :name]
+RailsConsoleToolkit.model_helper "Spree::Variant", as: :variant, by: [:sku]
+RailsConsoleToolkit.model_helper "Spree::Taxon", as: :taxon, by: [:permalink]
+RailsConsoleToolkit.model_helper "Spree::Order", as: :order, by: [:number]
+RailsConsoleToolkit.model_helper "Spree::User", as: :user, by: [:email]
+RailsConsoleToolkit.model_helper "Spree::Country", as: :country, by: [:iso, :iso3, :iso_name, :name]
+RailsConsoleToolkit.model_helper "Spree::Role", as: :role, by: [:name]
+RailsConsoleToolkit.model_helper "Spree::Promotion", as: :promotion, by: [:name]
+RailsConsoleToolkit.alias_helper :promo, :promotion

data/lib/rails_console_toolkit/version.rb

@@ -1,3 +1,3 @@
 module RailsConsoleToolkit
-  VERSION = "0.4.0"
+  VERSION = "0.6.0"
 end

data/rails_console_toolkit.gemspec

@@ -30,6 +30,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "rails", '>= 4'
 
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "minitest", "~> 5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_console_toolkit
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Elia Schito
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-10-09 00:00:00.000000000 Z
+date: 2020-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -42,16 +42,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -74,15 +74,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
+- ".github/config.yml"
+- ".github/workflows/build.yml"
 - ".gitignore"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- lib/generators/rails_console_toolkit/install/install_generator.rb
+- lib/generators/rails_console_toolkit/install/templates/initializer.rb
 - lib/rails_console_toolkit.rb
 - lib/rails_console_toolkit/aliases.rb
 - lib/rails_console_toolkit/helpers.rb
@@ -96,7 +98,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/nebulab/rails_console_toolkit#readme
   source_code_uri: https://github.com/nebulab/rails_console_toolkit
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -111,8 +113,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Configurable Rails Console Helpers
 test_files: []

data/.travis.yml

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