nrb 1.1.0 → 1.1.1

data/README.md

@@ -1,138 +1,121 @@
-# Ninja Ruby - `nrb` [![Gem Version](https://badge.fury.io/rb/nrb.svg)](https://badge.fury.io/rb/nrb)
-
-[![Build Status](https://travis-ci.org/shuriu/nrb.svg?branch=master)](https://travis-ci.org/shuriu/nrb) [![Coverage Status](https://coveralls.io/repos/github/shuriu/nrb/badge.svg?branch=master)](https://coveralls.io/github/shuriu/nrb?branch=master) [![Code Climate](https://codeclimate.com/github/shuriu/nrb/badges/gpa.svg)](https://codeclimate.com/github/shuriu/nrb) [![Dependency Status](https://gemnasium.com/shuriu/nrb.svg)](https://gemnasium.com/shuriu/nrb)
+# `nrb` - Ninja Ruby scripts - [![Gem Version](https://badge.fury.io/rb/nrb.svg)](https://badge.fury.io/rb/nrb)
 
 Ninja Ruby scripts with easy persistence for your experimenting needs.
 
-# Idea
+Do you want to work on some idea that's more than a script but you don't want to generate a fully fleged Rails app?
 
-**TLDR**: `$ nrb new <idea-name>`
+**`nrb`** generates a simple scaffold for your script. Complete with autoloading, custom configurations and persistence. Just like a mini rails.
 
-Say you want to validate some idea. Maybe crawl some page, API, or process some file. Whatever scratches your itch.
+## Getting Started
 
-> Cool, I can get all this data from there. But what do I do with it?
+1. First install the gem:
 
-So you want some kind of persistence?
+        $ gem install nrb
 
-> I'll just dump the data in memory into some array or object, then do some stuff to it later.
+2. Create your new Ninja Ruy project:
 
-But maybe you want to show it to some colleague or your boss.
+        $ nrb new my-project
 
-> Ok I'll dump it into some file.
+  `my-project` is your project name.
 
-Now we're getting somewhere. But it's hard to analyze later. Or you don't want to hit the API again when you run your script.
+3. Change the directory to `my-project` and start hacking:
 
-> Hmm, I'll just dump it in some database!
+        $ cd my-project
 
-And 5 minutes later you realize it's just a simple script. You don't want to mess with all the boilerplate required to setup the db and query it with ugly SQL.
+        ├── config
+        │   ├── boot.rb
+        │   └── nrb.rb
+        ├── db
+        │   └── config.yml
+        ├── models
+        ├── services
+        ├── Gemfile
+        ├── my-project.rb
+        ├── Rakefile
+        └── README.md
 
-Also, as you hit more and more edge cases with your idea, you realize you just have a big `.rb` file with no structure and your idea is hidden inside loops and control structures instead.
+4. Your main file is `my-project.rb`. Add your ideas here. You can also add more gems to the `Gemfile` and they will be automatically required.
 
-> I'll add some structure then: extract some methods into classes and classes into files and...
+  You can also change the `config/nrb.rb` file to add custom configurations.
 
-And now you have to do boilerplate for requiring files..
+  Also, everything you add to `models` and `services` will be required automatically.
 
-> Fuck it, I'll just do a Rails App!
+5. To run your script:
 
-Or you could just use `$ nrb new <idea-name>` and not worry about anything!
+        $ nrb start
 
-## Installation
+  And to start the console with your script loaded:
 
-    $ gem install nrb
+      $ nrb console
 
-## Usage
+## Models
 
-```sh
-$ nrb help
-Commands:
-  nrb [c]onsole                     # Jump into a Pry console with your project loaded. NOTE: Available inside a NinjaRuby project
-  nrb [d]estroy <resource> <name>   # Destroy a generated resource. NOTE: Available inside a NinjaRuby project
-  nrb [g]enerate <resource> <name>  # Generate a resource (models, services). NOTE: Available inside a NinjaRuby project
-  nrb [s]tart                       # Require the main file. NOTE: Available inside a NinjaRuby project
-  nrb help [COMMAND]                # Describe available commands or one specific command
-  nrb new <name-or-path> [OPTIONS]  # Creates a Ninja Ruby Script at the given path
-```
+You can enjoy all the goodness `ActiveRecord` provides, outside Rails, and without the bolierplate needed. The commands are almost the same as in Rails.
 
-Create an app and some resources:
-
-```sh
-$ nrb help new
-Usage:
-  nrb new <name-or-path> [OPTIONS]
-
-Options:
-  -r, [--init-repo], [--no-init-repo]            # Initialize a repository at the target location
-                                                 # Default: true
-  -b, [--bundle-install], [--no-bundle-install]  # Run bundle install after generating the skeleton
-                                                 # Default: true
-Creates a Ninja Ruby Script at the given path
-
-$ nrb new user_importer
-      create  user_importer/.gitignore
-      create  user_importer/README.md
-      create  user_importer/Gemfile
-      create  user_importer/Rakefile
-      create  user_importer/config/nrb.rb
-      create  user_importer/models/.keep
-      create  user_importer/services/.keep
-      create  user_importer/config/boot.rb
-      create  user_importer/db/config.yml
-      create  user_importer/user_importer.rb
-$ cd user_importer
-
-$ rake db:create
-
-$ nrb g model user first_name last_name email
-      create  models/user.rb
-         run  rake db:new_migration name=create_users options='first_name last_name email' from "."
-      create  db/migrate/20160309074029_create_users.rb
-
-$ rake db:migrate
-
-$ nrb console
-
-[1] pry(main)> User.create(first_name: 'Gandalf', last_name: 'The Grey', email: 'gandalf@example.com')
-D, [2016-03-09T09:44:12.434679 #21739] DEBUG -- :    (0.1ms)  begin transaction
-D, [2016-03-09T09:44:12.440635 #21739] DEBUG -- :   SQL (0.5ms)  INSERT INTO "users" ("first_name", "last_name", "email") VALUES (?, ?, ?)  [["first_name", "Gandalf"], ["last_name", "The Grey"], ["email", "gandalf@example.com"]]
-D, [2016-03-09T09:44:12.444638 #21739] DEBUG -- :    (3.6ms)  commit transaction
-=> #<User:0x005582ec4153d8 id: 1, first_name: "Gandalf", last_name: "The Grey", email: "gandalf@example.com">
-
-[2] pry(main)> User.all
-D, [2016-03-09T09:45:11.252371 #21739] DEBUG -- :   User Load (0.2ms)  SELECT "users".* FROM "users"
-=> [#<User:0x005582ed31c3e0 id: 1, first_name: "Gandalf", last_name: "The Grey", email: "gandalf@example.com">]
+1. Create the database:
 
-```
+        $ rake db:create
+
+2. Create a model:
+
+        $ nrb g model user username email
+
+        db/migrate
+        └── 20160311091641_create_users.rb
+        models
+        └── user.rb
+
+
+  You can then edit the migration and the model as you please.
+
+3. Finally run the migration!
+
+        $ rake db:migrate
+
+## Services
+
+These are just simple classes with the added benefit of being automatically Required in your main script file (the `my-project.rb` from the examples above).
+
+To add a service:
+
+        $ nrb g service user_service
+
+        services
+        └── user_service.rb
 
 ## Configuration
 
-To add custom configurations or change existing ones, you can modify `config/nrb.rb`:
+You can add or change configurations inside `config/nrb.rb`:
 
 ```ruby
 Nrb.configure do |config|
   # Root of the script folder
   config.root = File.expand_path('..', __dir__)
 
-  # Default resources to autoload
-  # config.resources = %w(models services)
+  # Default directories to autoload
+  # config.autoload = %w(models services)
+
+  # My custom config
+  config.my_custom_config = :foo
 end
 ```
 
-To configure the default sqlite db, you can update `db/config.yml`:
-
-```yaml
-development:
-  adapter:  sqlite3
-  pool:     5
-  timeout:  5000
-  database: db/new_script.sqlite3
-```
+You can access them by simply calling: `Nrb.config.my_custom_config`.
 
 ## Roadmap
 
-- [x] Tests
-- [ ] Support for custom bundler groups
-- [ ] Ability to change the persistence adapter
-- [ ] Ability to skip persistence altogether
+- [ ] Add generator for tests.
+- [ ] Add support for custom bundler groups.
+- [ ] Add ability to change the persistence adapter. Currently `sqlite` is the default.
+- [ ] Add ability to skip persistence altogether.
+
+## Contributing
+
+General feedback, bug reports and pull requests are more than welcome!
+
+## Status
+
+[![Build Status](https://travis-ci.org/shuriu/nrb.svg?branch=master)](https://travis-ci.org/shuriu/nrb) [![Coverage Status](https://coveralls.io/repos/github/shuriu/nrb/badge.svg?branch=master)](https://coveralls.io/github/shuriu/nrb?branch=master) [![Code Climate](https://codeclimate.com/github/shuriu/nrb/badges/gpa.svg)](https://codeclimate.com/github/shuriu/nrb) [![Dependency Status](https://gemnasium.com/shuriu/nrb.svg)](https://gemnasium.com/shuriu/nrb)
 
 ## Development
 
@@ -140,11 +123,6 @@ Run `rake test` to run the tests. You can also run `bin/console` for an interact
 
 To install this gem onto your local machine, run `bundle exec rake install`.
 
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/shuriu/nrb.
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/Rakefile

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

data/bin/console

@@ -1,14 +1,6 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "nrb"
+require 'bundler/setup'
+require 'nrb'
 
-# 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

data/lib/nrb/cli.rb

@@ -4,28 +4,34 @@ require 'thor'
 require 'nrb/commands/all'
 
 module Nrb
+  # Command line interface entry point.
   class CLI < Thor
     class_option :verbose, type: :boolean, default: true,
       desc:    'Verbose mode.',
       aliases: '-v'
 
-    register Nrb::Commands::Script, 'new', 'new <name-or-path> [OPTIONS]',
+    register Nrb::Commands::Script, 'new',
+      'new <name-or-path> [OPTIONS]',
       Nrb::Commands::Script.desc
     tasks['new'].options = Nrb::Commands::Script.class_options
 
-    register Nrb::Commands::Starter, 'start', '[s]tart',
+    register Nrb::Commands::Starter, 'start',
+      '[s]tart',
       Nrb::Commands::Starter.desc
     map 's' => :start
 
-    register Nrb::Commands::Console, 'console', '[c]onsole',
+    register Nrb::Commands::Console, 'console',
+      '[c]onsole',
       Nrb::Commands::Console.desc
     map 'c' => :console
 
-    register Nrb::Commands::Generate, 'generate', '[g]enerate <resource> <name>',
+    register Nrb::Commands::Generate, 'generate',
+      '[g]enerate <resource> <name>',
       Nrb::Commands::Generate.desc
     map 'g' => :generate
 
-    register Nrb::Commands::Destroy, 'destroy', '[d]estroy <resource> <name>',
+    register Nrb::Commands::Destroy, 'destroy',
+      '[d]estroy <resource> <name>',
       Nrb::Commands::Destroy.desc
     map 'd' => :destroy
   end

data/lib/nrb/commands/base/base.rb

@@ -1,5 +1,6 @@
 module Nrb
   module Commands
+    # This class is the base class for other thor groups.
     class Base < Thor::Group
       include Thor::Actions
 
@@ -18,12 +19,12 @@ module Nrb
       private
 
       def require_main_file
-        assumed_file_name = "#{Nrb.root.split('/').last}.rb"
-        assumed_file_path = File.join(Nrb.root, assumed_file_name)
+        root = Nrb.root
+        assumed_file_name = "#{root.split('/').last}.rb"
+        assumed_file_path = File.join(root, assumed_file_name)
+        return false unless File.exist?(assumed_file_path)
 
-        if File.exist?(assumed_file_path)
-          require File.join(Nrb.root, assumed_file_name)
-        end
+        require assumed_file_path
       end
     end
   end

data/lib/nrb/commands/base/inside.rb

@@ -1,5 +1,7 @@
 module Nrb
   module Commands
+    # This class fires a task that checks if the following command
+    # is done inside the root of the project.
     class Inside < Commands::Base
       def ensure_inside_root
         return true if Nrb.inside?
@@ -12,7 +14,8 @@ module Nrb
         command = self.class.to_s.split('::').last
 
         fail Nrb::OutsideRootError,
-          "You need to be inside a NinjaRuby folder to run the #{command} command."
+          'You need to be inside a NinjaRuby folder' \
+          "to run the #{command} command."
       end
     end
   end

data/lib/nrb/commands/base/resource.rb

@@ -1,10 +1,12 @@
 module Nrb
   module Commands
+    # This class fires a task that checks if the following command
+    # is done on the correct resource type.
     class Resource < Commands::Inside
       include ResourceGenerator
 
       def self.valid_resources
-        arguments.find { |a| a.name == 'resource' }.enum
+        arguments.find { |arg| arg.name == 'resource' }.enum
       end
 
       def ensure_valid_resource

data/lib/nrb/commands/concerns/resource_generator.rb

@@ -2,6 +2,8 @@ require 'active_support/concern'
 
 module Nrb
   module Commands
+    # This module adds the :resource, and the :name to resource generator
+    # commands (generate or destroy).
     module ResourceGenerator
       extend ActiveSupport::Concern
 
@@ -9,7 +11,7 @@ module Nrb
         argument :resource, type: :string, required: true,
           desc:   'resource type',
           banner: 'resource',
-          enum:   Nrb.config.resources.map(&:singularize)
+          enum:   Nrb.resources.map(&:singularize)
 
         argument :name, type: :string, required: true,
           desc:   'name of the resource',

data/lib/nrb/commands/concerns/script_generator.rb

@@ -0,0 +1,59 @@
+require 'active_support/concern'
+
+module Nrb
+  module Commands
+    # This module adds the :path_or_folder_name required argument,
+    # and some helper flags like: --init-repo, --bundle-install, --local.
+    module ScriptGenerator
+      extend ActiveSupport::Concern
+
+      included do
+        argument :path_or_folder_name, type: :string, required: true,
+          desc: 'The name of the project, or the path.'
+
+        class_option :init_repo, default: true, type: :boolean,
+          desc: 'Initialize a repository at the target location.',
+          aliases: '-r'
+
+        class_option :bundle_install, default: false, type: :boolean,
+          desc: 'Run bundle install after generating the skeleton.',
+          aliases: '-b'
+
+        class_option :local, default: false, type: :boolean,
+          desc: 'Add local path of the gem when ' \
+                'generating the Gemfile. Useful for testing.'
+      end
+
+      private
+
+      def try_loud_command(command)
+        opts[:verbose] ? run(command) : silent_command(command)
+      end
+
+      def silent_command(command)
+        Nrb::Utils.silently { run command }
+      end
+
+      def target(final = nil)
+        File.join(File.expand_path(path_or_folder_name), final.to_s)
+      end
+
+      def name
+        File.basename(path_or_folder_name)
+      end
+
+      def nrb_gem
+        text = "gem 'nrb', '#{Nrb::VERSION}'"
+        add_local_path(text) if options[:local]
+        text
+      end
+
+      def add_local_path(text)
+        local_gem_path = Pathname.new(File.expand_path('../../..', __dir__))
+        target_path    = Pathname.new(target)
+        relative_path  = local_gem_path.relative_path_from(target_path)
+        text << ", path: '#{relative_path}'"
+      end
+    end
+  end
+end

data/lib/nrb/commands/console.rb

@@ -1,5 +1,6 @@
 module Nrb
   module Commands
+    # Command that loads the script and starts a pry console.
     class Console < Commands::Inside
       desc 'Jump into a Pry console with your project loaded.'
 

data/lib/nrb/commands/destroy.rb

@@ -1,7 +1,7 @@
-require 'nrb/commands/concerns/resource_generator'
-
 module Nrb
   module Commands
+    # This command destroys a resource, and if it is a model, it also destroys
+    # the correspnding create migration file.
     class Destroy < Commands::Resource
       desc 'Destroy a generated resource.'
 
@@ -11,8 +11,9 @@ module Nrb
 
       def destroy_migration
         return false unless resource == 'model'
-        migration_file = Dir["db/migrate/*_create_#{name.underscore.pluralize}.rb"].first
-        remove_file(migration_file, opts) if migration_file
+        prefix = 'db/migrate/*_create_'
+        migration_file = Dir["#{prefix}#{name.underscore.pluralize}.rb"].first
+        remove_file(migration_file, opts)
       end
     end
   end

data/lib/nrb/commands/generate.rb

@@ -1,26 +1,33 @@
 module Nrb
   module Commands
+    # This command generates a resource, and if it is a model, it also
+    # generates the correspnding create migration file.
     class Generate < Commands::Resource
       desc "Generate a resource (#{valid_resources.join(', ')})."
 
       def generate_resource
         template "templates/#{resource}.rb.tt", target("#{name.underscore}.rb"),
-          opts.merge({ name: name.camelize })
+          opts.merge(name: name.camelize)
       end
 
       def generate_table
         return false unless resource == 'model'
 
-        migration_name = "create_#{name.underscore.pluralize}"
-        rake_options   = args.join(' ')
-
         inside Nrb.root, opts do
-          Nrb.silently(opts) do
-            run "bundle exec rake db:new_migration name=#{migration_name} options='#{rake_options}'",
-              opts
+          Nrb::Utils.silently do
+            generate_table_file
           end
         end
       end
+
+      private
+
+      def generate_table_file
+        migration_name = "create_#{name.underscore.pluralize}"
+        rake_options   = args.join(' ')
+        command        = 'bundle exec rake db:new_migration'
+        run "#{command} name=#{migration_name} options='#{rake_options}'", opts
+      end
     end
   end
 end

data/lib/nrb/commands/script.rb

@@ -1,23 +1,13 @@
 require 'pathname'
+require 'nrb/commands/concerns/script_generator'
 
 module Nrb
   module Commands
+    # This command generates a new script scaffold.
     class Script < Commands::Base
-      desc 'Creates a Ninja Ruby Script at the given path.'
-
-      argument :path_or_folder_name, type: :string, required: true,
-        desc: 'The name of the project, or the path.'
-
-      class_option :init_repo, default: true, type: :boolean,
-        desc: 'Initialize a repository at the target location.',
-        aliases: '-r'
-
-      class_option :bundle_install, default: false, type: :boolean,
-        desc: 'Run bundle install after generating the skeleton.',
-        aliases: '-b'
+      include ScriptGenerator
 
-      class_option :local, default: false, type: :boolean,
-        desc: 'Add local path of the gem when generating the Gemfile. Useful for testing.'
+      desc 'Creates a Ninja Ruby Script at the given path.'
 
       def gitignore
         template 'templates/.gitignore.tt', target('.gitignore'), opts
@@ -25,12 +15,12 @@ module Nrb
 
       def readme
         template 'templates/README.md.tt', target('README.md'),
-          opts.merge({ title: name, version: Nrb::VERSION })
+          opts.merge(title: name, version: Nrb::VERSION)
       end
 
       def gemfile
         template 'templates/Gemfile.tt', target('Gemfile'),
-          opts.merge({ nrb_gem: nrb_gem })
+          opts.merge(nrb_gem: nrb_gem)
       end
 
       def rakefile
@@ -39,11 +29,11 @@ module Nrb
 
       def config_nrb
         template 'templates/config/nrb.rb.tt', target('config/nrb.rb'),
-          opts.merge({ resources: Nrb.config.resources })
+          opts.merge(resources: Nrb.resources)
       end
 
       def resources
-        Nrb.config.resources.each do |dir|
+        Nrb.resources.each do |dir|
           create_file target("#{dir}/.keep"), opts
         end
       end
@@ -54,7 +44,7 @@ module Nrb
 
       def db_config
         template 'templates/db/config.yml.tt', target('db/config.yml'),
-          opts.merge({ db: name })
+          opts.merge(db: name)
       end
 
       def script_file
@@ -65,9 +55,7 @@ module Nrb
         return unless options[:init_repo]
 
         inside target, opts do
-          Nrb.silently verbose: options[:verbose] do
-            run 'git init'
-          end
+          try_loud_command('git init')
         end
       end
 
@@ -76,35 +64,10 @@ module Nrb
 
         inside target, opts do
           Bundler.with_clean_env do
-            Nrb.silently verbose: options[:verbose] do
-              run 'bundle install'
-            end
+            try_loud_command('bundle install')
           end
         end
       end
-
-      private
-
-      def nrb_gem
-        text = "gem 'nrb', '#{Nrb::VERSION}'"
-
-        if options[:local]
-          local_gem_path = Pathname.new(File.expand_path('../../..', __dir__))
-          target_path    = Pathname.new(target)
-          relative_path  = local_gem_path.relative_path_from(target_path)
-          text << ", path: '#{relative_path}'"
-        end
-
-        text
-      end
-
-      def target(final = nil)
-        File.join(File.expand_path(path_or_folder_name), final.to_s)
-      end
-
-      def name
-        File.basename(path_or_folder_name)
-      end
     end
   end
 end

data/lib/nrb/commands/starter.rb

@@ -1,5 +1,6 @@
 module Nrb
   module Commands
+    # Command that loads the script.
     class Starter < Commands::Inside
       desc 'Require the main file.'
 

data/lib/nrb/errors.rb

@@ -1,4 +1,9 @@
 module Nrb
-  class OutsideRootError < Thor::Error; end;
-  class InvalidResourceError < Thor::Error; end;
+  # Raised when a command that needs to be run inside a project root,
+  # is actually ran outside.
+  class OutsideRootError < Thor::Error; end
+
+  # Raised when a command that needs to generate or destroy a resource,
+  # needs a name, and the name supplied is wrong.
+  class InvalidResourceError < Thor::Error; end
 end

data/lib/nrb/templates/config/boot.rb.tt

@@ -19,7 +19,7 @@ ActiveRecord::Base.configurations = YAML.load_file('db/config.yml')
 ActiveRecord::Base.establish_connection(:development)
 ActiveRecord::Base.logger = Logger.new(STDOUT)
 
-# Finally require files inside config.resources
-Nrb.config.resources.each do |dir|
+# Finally require files inside resources
+Nrb.config.autoload.each do |dir|
   Dir[File.join(dir, '*.rb')].each { |f| require(f) }
 end

data/lib/nrb/templates/config/nrb.rb.tt

@@ -2,6 +2,6 @@ Nrb.configure do |config|
   # Root of the script folder
   config.root = File.expand_path('..', __dir__)
 
-  # Default resources to autoload
-  # config.resources = %w(<%= config[:resources].join(' ') %>)
+  # Default directories to autoload
+  # config.autoload = %w(<%= config[:resources].join(' ') %>)
 end