rails_console_toolkit 0.1.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c63ae0fa9d97e7519b9e84c9ccaec90f2be8f5cfef5e8b25729debfe5d0dd374
-  data.tar.gz: 8de43d13ff473dee04f9130f9d22497412a3a67dc77fa7d7bdfb2fbfaefa94c1
+  metadata.gz: a865af4dc1a6a3fdf9eaafa25cbba4ac02bc44b88b10bab7931e744fc4e13212
+  data.tar.gz: d57b3c408d1c781d3861eca231555bf8f86a8c0b6ecfa7efa56348803645cf8b
 SHA512:
-  metadata.gz: aa3fe513e335e98f6c498969dc442847533efffa87536801e3bdcc3626c6f4e0b3b19fa87fedfd436b4a8f9d2da3e8f2fa2636b0913c237a84d071215f9b98f5
-  data.tar.gz: d9e67100e2b6619bf69f8ce170a6e7325cd85e20e2109eefe479869f1b416c2ebe06a83a61ee44b7af921e7c16191d1fe3f925b4a89d26150349db1a6c47dc3b
+  metadata.gz: 01a811e7da05c9c6752d76fcd404f15855a01842571880de44d7a9131ef8a2cc5828b3cb3a380241a6a0403c1aabac3c1a50439a7ec367b8507399efefabbf89
+  data.tar.gz: 8eded7fe42d1c55b00297985dac767f5b80c80c29fdaf3831b5ded2502e976666d6ea5112f3a9dd173a53e43a16110e00e0e3b206da2ebcaab5351c3fc912291

data/.circleci/config.yml

@@ -0,0 +1,32 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.6
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{ checksum "Gemfile" }}
+            - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            gem install bundler
+            bundle update --jobs=4 --retry=3 --path tmp/bundle || \
+              bundle install --jobs=4 --retry=3 --path tmp/bundle
+
+      - save_cache:
+          paths:
+            - ./tmp/bundle
+          key: v1-dependencies-{{ checksum "Gemfile" }}
+
+      - run:
+          name: run tests
+          command: |
+            bundle exec rake

data/README.md

@@ -4,6 +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)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -12,14 +14,15 @@ Add this line to your application's Gemfile:
 gem 'rails_console_toolkit'
 ```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
+And then configure it within an initializer:
 
-    $ gem install rails_console_toolkit
+```ruby
+# config/initializers/console.rb
 
+RailsConsoleToolkit.configure do |config|
+  # helper definitions go here...
+end
+```
 
 ## Helper packs
 
@@ -28,7 +31,9 @@ Or install it yourself as:
 ```ruby
 # config/initializers/console.rb
 
-require 'rails_console_toolkit/aliases'
+RailsConsoleToolkit.configure do |config|
+  config.use_pack :aliases
+end
 ```
 
 ```
@@ -42,7 +47,9 @@ require 'rails_console_toolkit/aliases'
 ```ruby
 # config/initializers/console.rb
 
-require 'rails_console_toolkit/aliases'
+RailsConsoleToolkit.configure do |config|
+  config.use_pack :utils
+end
 ```
 
 ```
@@ -59,7 +66,9 @@ foo (3000.6ms)
 ```ruby
 # config/initializers/console.rb
 
-require 'rails_console_toolkit/aliases'
+RailsConsoleToolkit.configure do |config|
+  config.use_pack :solidus
+end
 ```
 
 ```
@@ -72,24 +81,17 @@ require 'rails_console_toolkit/aliases'
 > country(...) # => will look for Spree::Country records by :id, :iso, :iso3, :iso_name, :name
 ```
 
-## Usage
-
-```ruby
-# config/initializers/console.rb
-
-# helper definitions go here...
-
-RailsConsoleToolkit.install!
-```
-
+## Custom Helpers
 
 ### Generic helpers
 
 ```ruby
 # config/initializers/console.rb
 
-RailsConsoleToolkit.helper :foo do
-  :bar
+RailsConsoleToolkit.configure do |config|
+  config.helper :foo do
+    :bar
+  end
 end
 ```
 
@@ -104,7 +106,9 @@ end
 ```ruby
 # config/initializers/console.rb
 
-RailsConsoleToolkit.alias :r, :reload!
+RailsConsoleToolkit.configure do |config|
+  config.alias :r, :reload!
+end
 ```
 
 ```
@@ -118,7 +122,9 @@ RailsConsoleToolkit.alias :r, :reload!
 ```ruby
 # config/initializers/console.rb
 
-RailsConsoleToolkit.model_helper 'Spree::Product', as: :product, by: %i[:name, :slug]
+RailsConsoleToolkit.configure do |config|
+  config.model_helper 'Spree::Product', as: :product, by: %i[:name, :slug]
+end
 ```
 
 
@@ -136,10 +142,11 @@ RailsConsoleToolkit.model_helper 'Spree::Product', as: :product, by: %i[:name, :
 ```ruby
 # config/initializers/console.rb
 
-require 'rails_console_toolkit/aliases' # Will define an alias :x for "exit"
-
-RailsConsoleToolkit.remove_helper :x
-RailsConsoleToolkit.install!
+RailsConsoleToolkit.configure do |config|
+  # Will define an alias :x for "exit"
+  config.use_pack :aliases
+  config.remove_helper :x
+end
 ```
 
 ```
@@ -171,5 +178,6 @@ This project is funded and maintained by the [Nebulab][nebulab] team.
 We firmly believe in the power of open-source. [Contact us][contact-us] if you
 like our work and you need help with your project design or development.
 
-[nebulab]: http://nebulab.it/
-[nebulab-logo]: http://nebulab.it/assets/images/public/logo.svg
+[nebulab]: https://nebulab.it/
+[nebulab-logo]: https://nebulab.it/assets/images/public/logo.svg
+[contact-us]: https://nebulab.it/contact-us/

data/lib/rails_console_toolkit.rb

@@ -1,57 +1,19 @@
 require "rails_console_toolkit/version"
-require "active_support/core_ext/string/inflections"
 
 module RailsConsoleToolkit
-  extend self
+  autoload :Helpers, "rails_console_toolkit/helpers"
 
   class Error < StandardError; end
 
-  def install!
-    require 'rails/console/app'
-
-    helper_methods.each do |name, block|
-      Rails::ConsoleMethods.define_method(name, &block)
-    end
-  end
-
-  def helper(name, &block)
-    helper_methods[name.to_sym] = block
+  def self.setup
+    extend Helpers
   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
-    attribute_names = by || []
-
-    record = nil # use the closure as a cache
-
-    helper method_name do |key = nil|
-      unless cached
-        record = nil
-        raise("missing key for #{key}") unless key
-      end
-
-      if key
-        record ||= klass.find(key) if key.is_a? Numeric
-        attribute_names.find { |name| record ||= klass.find_by(name => key) }
-      end
-
-      record
+  def self.configure(&block)
+    Rails.application.console do
+      setup
+      block.call(self)
+      install!
     end
   end
-
-  def alias_helper(new_name, old_name)
-    helper(new_name) { send(old_name) }
-  end
-
-  def remove_helper(name)
-    helper_methods.delete(name.to_sym)
-  end
-
-  private
-
-  def helper_methods
-    @helper_methods ||= {}
-  end
 end

data/lib/rails_console_toolkit/aliases.rb

@@ -1,2 +1,2 @@
 RailsConsoleToolkit.alias_helper :x, :exit
-RailsConsoleToolkit.alias_helper :r, :reload
+RailsConsoleToolkit.alias_helper :r, :reload!

data/lib/rails_console_toolkit/helpers.rb

@@ -0,0 +1,56 @@
+require "active_support/core_ext/string/inflections"
+
+module RailsConsoleToolkit::Helpers
+  def use_pack pack_name
+    unless %w[aliases solidus utils].include? pack_name.to_s
+      raise Error, "unknown pack name: #{pack_name}"
+    end
+
+    require "rails_console_toolkit/#{pack_name}"
+  end
+
+  def install!(target_module = Rails::ConsoleMethods)
+    helper_methods.each do |name, block|
+      target_module.define_method(name, &block)
+    end
+  end
+
+  def helper(name, &block)
+    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
+    attribute_names = by || []
+
+    record = nil # use the closure as a cache
+
+    helper method_name do |key = nil|
+      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
+
+      record
+    end
+  end
+
+  def alias_helper(new_name, old_name)
+    helper(new_name) { |*args, &block| send(old_name, *args, &block) }
+  end
+
+  def remove_helper(name)
+    helper_methods.delete(name.to_sym)
+  end
+
+  private
+
+  def helper_methods
+    @helper_methods ||= {}
+  end
+end

data/lib/rails_console_toolkit/solidus.rb

@@ -11,3 +11,6 @@ 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 :promo, :promotion

data/lib/rails_console_toolkit/version.rb

@@ -1,3 +1,3 @@
 module RailsConsoleToolkit
-  VERSION = "0.1.0"
+  VERSION = "0.5.1"
 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.1.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Elia Schito
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-05 00:00:00.000000000 Z
+date: 2020-06-03 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,6 +74,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
@@ -84,6 +85,7 @@ files:
 - bin/setup
 - lib/rails_console_toolkit.rb
 - lib/rails_console_toolkit/aliases.rb
+- lib/rails_console_toolkit/helpers.rb
 - lib/rails_console_toolkit/solidus.rb
 - lib/rails_console_toolkit/utils.rb
 - lib/rails_console_toolkit/version.rb
@@ -109,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Configurable Rails Console Helpers