rails_console_toolkit 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 223e8d9bdedf22d2c25b6c515df5af7fe8f33980318bd87888a92e21b5d54cb7
-  data.tar.gz: c27d78e827bdb5528a7a05dd9a8c452ea63952655dc85fd20fa0bb0a340f21d3
+  metadata.gz: 1cd8126fdabd86bec0f64ff953337ae9a4a1435114ea35018406f322b6d7f8c6
+  data.tar.gz: 3a0984cfe0561fc91ba564ca94d0d97e97e8246628a55da85e408e8e32f24699
 SHA512:
-  metadata.gz: 040261a34dd02e4685b5b3df338d9b3a9d728192696a2923a9195ae1766643794eaf67b5ec42629807ddf53cef1b134b85e3a8c250b49584cf4983e412218a81
-  data.tar.gz: 84546672daa15fb371d058785cfb12bcd22feab96990d2608c379fe94ee6d1c08bfb70a9379e179b3d61a04c226992aad2ae21b40b0a0462427ef5187b2100d7
+  metadata.gz: d1261ef9b37861766bee33d0d06846042b6068aac61eec05bd9f4c606f42b98a46f8ef0ba6d6969c6a672724e91bed18c427a60263c30cf82155a0c354a457ae
+  data.tar.gz: 43668cca3112f56ddf0aa255f2d75c4d607c75d4a348a0ca49426a441f6c0c6123d9423bf8ca1e87b9bfc7435cfee137ab1b02c5c150e67290546b9d4854fb8d

data/README.md

@@ -14,14 +14,15 @@ Add this line to your application's Gemfile:
 gem 'rails_console_toolkit'
 ```
 
-And then execute:
+And then configure it within an initializer:
 
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install rails_console_toolkit
+```ruby
+# config/initializers/console.rb
 
+RailsConsoleToolkit.configure do |config|
+  # helper definitions go here...
+end
+```
 
 ## Helper packs
 
@@ -30,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
 ```
 
 ```
@@ -44,7 +47,9 @@ require 'rails_console_toolkit/aliases'
 ```ruby
 # config/initializers/console.rb
 
-require 'rails_console_toolkit/utils'
+RailsConsoleToolkit.configure do |config|
+  config.use_pack :utils
+end
 ```
 
 ```
@@ -61,7 +66,9 @@ foo (3000.6ms)
 ```ruby
 # config/initializers/console.rb
 
-require 'rails_console_toolkit/solidus'
+RailsConsoleToolkit.configure do |config|
+  config.use_pack :solidus
+end
 ```
 
 ```
@@ -74,24 +81,17 @@ require 'rails_console_toolkit/solidus'
 > 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
 ```
 
@@ -106,7 +106,9 @@ end
 ```ruby
 # config/initializers/console.rb
 
-RailsConsoleToolkit.alias :r, :reload!
+RailsConsoleToolkit.configure do |config|
+  config.alias :r, :reload!
+end
 ```
 
 ```
@@ -120,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
 ```
 
 
@@ -138,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
 ```
 
 ```

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
+    cache_key = method_name
+    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 ||= 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) { 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/version.rb

@@ -1,3 +1,3 @@
 module RailsConsoleToolkit
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/rails_console_toolkit.rb

@@ -1,55 +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!(target_module = Rails::ConsoleMethods)
-    require 'rails/console/app'
-
-    helper_methods.each do |name, block|
-      target_module.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|
-      record = nil unless cached
-
-      if key
-        record = nil
-        record ||= klass.find(key) if Numeric === key
-        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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_console_toolkit
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Elia Schito
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-17 00:00:00.000000000 Z
+date: 2019-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -85,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