rails_console_toolkit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c63ae0fa9d97e7519b9e84c9ccaec90f2be8f5cfef5e8b25729debfe5d0dd374
+  data.tar.gz: 8de43d13ff473dee04f9130f9d22497412a3a67dc77fa7d7bdfb2fbfaefa94c1
+SHA512:
+  metadata.gz: aa3fe513e335e98f6c498969dc442847533efffa87536801e3bdcc3626c6f4e0b3b19fa87fedfd436b4a8f9d2da3e8f2fa2636b0913c237a84d071215f9b98f5
+  data.tar.gz: d9e67100e2b6619bf69f8ce170a6e7325cd85e20e2109eefe479869f1b416c2ebe06a83a61ee44b7af921e7c16191d1fe3f925b4a89d26150349db1a6c47dc3b

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+Gemfile.lock

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,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rails_console_toolkit.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Elia Schito
+
+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,175 @@
+# RailsConsoleToolkit 🔧🧰
+
+*Configurable Rails Console Helpers*
+
+Find records faster, add custom helpers, improve your console life by 100%.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_console_toolkit'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_console_toolkit
+
+
+## Helper packs
+
+### Aliases
+
+```ruby
+# config/initializers/console.rb
+
+require 'rails_console_toolkit/aliases'
+```
+
+```
+> x # alias exit
+> r # alias reload!
+```
+
+
+### Utils
+
+```ruby
+# config/initializers/console.rb
+
+require 'rails_console_toolkit/aliases'
+```
+
+```
+> benchmark("foo") { sleep 3 }
+foo (3000.6ms)
+=> 3
+
+> bm # alias benchmark
+```
+
+
+### [Solidus](https://solidus.io)
+
+```ruby
+# config/initializers/console.rb
+
+require 'rails_console_toolkit/aliases'
+```
+
+```
+> load_factories # will load solidus factories, useful to create dummy data in development
+> product(...) # => will look for Spree::Product records by :id, :slug, :name
+> variant(...) # => will look for Spree::Variant records by :id, :sku
+> taxon(...)   # => will look for Spree::Taxon   records by :id, :permalink
+> order(...)   # => will look for Spree::Order   records by :id, :number
+> user(...)    # => will look for Spree::User    records by :id, :email
+> 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!
+```
+
+
+### Generic helpers
+
+```ruby
+# config/initializers/console.rb
+
+RailsConsoleToolkit.helper :foo do
+  :bar
+end
+```
+
+```
+# bin/rails console
+
+> foo # => :bar
+```
+
+### Aliases
+
+```ruby
+# config/initializers/console.rb
+
+RailsConsoleToolkit.alias :r, :reload!
+```
+
+```
+# bin/rails console
+
+> r # The same as typing "reload!"
+```
+
+### Model helpers
+
+```ruby
+# config/initializers/console.rb
+
+RailsConsoleToolkit.model_helper 'Spree::Product', as: :product, by: %i[:name, :slug]
+```
+
+
+```
+# bin/rails console
+
+> product('black-tshirt') # => #<Spree::Product id: 123, name: "Black T-Shirt", slug: "black-tshirt", …>
+> product.slug            # => "black-tshirt"
+> product 456             # => #<Spree::Product id: 456, name: "Red T-Shirt", slug: "red-tshirt", …>
+> product.slug            # => "red-tshirt"
+```
+
+### Removing unwanted helpers
+
+```ruby
+# config/initializers/console.rb
+
+require 'rails_console_toolkit/aliases' # Will define an alias :x for "exit"
+
+RailsConsoleToolkit.remove_helper :x
+RailsConsoleToolkit.install!
+```
+
+```
+# bin/rails console
+
+> x # NameError (undefined local variable or method \`x' for main:Object)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/elia/rails_console_toolkit.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## About
+
+[![Nebulab][nebulab-logo]][nebulab]
+
+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

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rails_console_toolkit"
+
+# 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/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/lib/rails_console_toolkit.rb

@@ -0,0 +1,57 @@
+require "rails_console_toolkit/version"
+require "active_support/core_ext/string/inflections"
+
+module RailsConsoleToolkit
+  extend self
+
+  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
+  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
+    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

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

data/lib/rails_console_toolkit/solidus.rb

@@ -0,0 +1,13 @@
+RailsConsoleToolkit.helper :load_factories do
+  require 'factory_bot'
+  require 'spree/testing_support/factories'
+  FactoryBot.find_definitions
+  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]

data/lib/rails_console_toolkit/utils.rb

@@ -0,0 +1,14 @@
+RailsConsoleToolkit.helper :benchmark do |*args,&block|
+  @benchmarker ||= begin
+    benchmarker = Object.new
+    def benchmarker.logger
+      Rails.logger
+    end
+    benchmarker.extend ActiveSupport::Benchmarkable
+    benchmarker
+  end
+
+  @benchmarker.benchmark(*args, &block)
+end
+
+RailsConsoleToolkit.alias_helper :bm, :benchmark

data/lib/rails_console_toolkit/version.rb

@@ -0,0 +1,3 @@
+module RailsConsoleToolkit
+  VERSION = "0.1.0"
+end

data/rails_console_toolkit.gemspec

@@ -0,0 +1,35 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rails_console_toolkit/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_console_toolkit"
+  spec.version       = RailsConsoleToolkit::VERSION
+  spec.authors       = ["Elia Schito"]
+  spec.email         = ["elia@schito.me"]
+
+  spec.summary       = %q{Configurable Rails Console Helpers}
+  spec.description   = %q{Find records faster, add custom helpers, improve your console life by 100%.}
+  spec.homepage      = "https://github.com/nebulab/rails_console_toolkit#readme"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/nebulab/rails_console_toolkit"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails", '>= 4'
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: rails_console_toolkit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Elia Schito
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Find records faster, add custom helpers, improve your console life by
+  100%.
+email:
+- elia@schito.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rails_console_toolkit.rb
+- lib/rails_console_toolkit/aliases.rb
+- lib/rails_console_toolkit/solidus.rb
+- lib/rails_console_toolkit/utils.rb
+- lib/rails_console_toolkit/version.rb
+- rails_console_toolkit.gemspec
+homepage: https://github.com/nebulab/rails_console_toolkit#readme
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/nebulab/rails_console_toolkit#readme
+  source_code_uri: https://github.com/nebulab/rails_console_toolkit
+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.3
+signing_key: 
+specification_version: 4
+summary: Configurable Rails Console Helpers
+test_files: []