nrb 1.0.0 → 1.1.0

data/.travis.yml

@@ -1,4 +1,4 @@
 language: ruby
 rvm:
-  - 2.3.0
+  - 2.2.1
 before_install: gem install bundler -v 1.11.2

data/Guardfile

@@ -0,0 +1,12 @@
+guard :minitest do
+  ignore(%r{^test/(fixtures|coverage)})
+
+  watch(%r(^test/(.*)\/?(.*)_test\.rb$))
+  watch(%r(^lib/(.*/)?([^/]+)\.rb$))     { |m| "test/#{m[1]}#{m[2]}_test.rb" }
+  watch(%r(^test/test_helper\.rb$))      { 'test' }
+end
+
+guard :rubocop do
+  watch(%r{.+\.rb$})
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end

data/README.md

@@ -1,6 +1,8 @@
-# Ninja Ruby - Nrb
+# Ninja Ruby - `nrb` [![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
+[![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)
+
+Ninja Ruby scripts with easy persistence for your experimenting needs.
 
 # Idea
 
@@ -40,15 +42,103 @@ Or you could just use `$ nrb new <idea-name>` and not worry about anything!
 
 ## Usage
 
-    $ nrb help
-
-## TODO
+```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
+```
+
+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">]
+
+```
+
+## Configuration
+
+To add custom configurations or change existing ones, you can modify `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)
+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
+```
+
+## Roadmap
+
+- [x] Tests
+- [ ] Support for custom bundler groups
+- [ ] Ability to change the persistence adapter
+- [ ] Ability to skip persistence altogether
 
 ## Development
 
 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).
+To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 

data/Rakefile

@@ -7,4 +7,4 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :default => :spec
+task :default => :test

data/lib/nrb.rb

@@ -4,10 +4,16 @@ require 'binding_of_caller'
 require 'pry-byebug'
 require 'standalone_migrations'
 require 'sqlite3'
+require 'nrb/errors'
 require 'nrb/version'
 
 module Nrb
-  class Configuration < OpenStruct; end
+  class Configuration < OpenStruct
+    def initialize(*args)
+      super
+      self.resources = %w(models services)
+    end
+  end
 
   class << self
     def config
@@ -27,11 +33,16 @@ module Nrb
 
       !!(File.read(gemfile) =~ /gem\s+['"]nrb['"]/)
     end
-  end
-end
 
-Nrb.configure do |config|
-  config.directories = %w(models services)
+    def silently(verbose: false)
+      yield and return if verbose
+
+      original_stdout = $stdout.clone
+      $stdout.reopen '/dev/null'
+      yield
+      $stdout.reopen original_stdout
+    end
+  end
 end
 
 require 'nrb/cli'

data/lib/nrb/cli.rb

@@ -1,14 +1,14 @@
 require 'pry'
 require 'binding_of_caller'
 require 'thor'
-require 'nrb/commands/script'
-require 'nrb/commands/starter'
-require 'nrb/commands/console'
-require 'nrb/commands/generate'
-require 'nrb/commands/destroy'
+require 'nrb/commands/all'
 
 module Nrb
   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]',
       Nrb::Commands::Script.desc
     tasks['new'].options = Nrb::Commands::Script.class_options

data/lib/nrb/commands/all.rb

@@ -0,0 +1,11 @@
+require 'nrb/commands/concerns/resource_generator'
+
+require 'nrb/commands/base/base'
+require 'nrb/commands/base/inside'
+require 'nrb/commands/base/resource'
+
+require 'nrb/commands/script'
+require 'nrb/commands/starter'
+require 'nrb/commands/console'
+require 'nrb/commands/generate'
+require 'nrb/commands/destroy'

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

@@ -0,0 +1,30 @@
+module Nrb
+  module Commands
+    class Base < Thor::Group
+      include Thor::Actions
+
+      class_option :verbose, type: :boolean, default: true,
+        desc:    'Verbose mode.',
+        aliases: '-v'
+
+      def self.source_root
+        File.expand_path('../..', __dir__)
+      end
+
+      def opts
+        options.to_h.symbolize_keys
+      end
+
+      private
+
+      def require_main_file
+        assumed_file_name = "#{Nrb.root.split('/').last}.rb"
+        assumed_file_path = File.join(Nrb.root, assumed_file_name)
+
+        if File.exist?(assumed_file_path)
+          require File.join(Nrb.root, assumed_file_name)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module Nrb
+  module Commands
+    class Inside < Commands::Base
+      def ensure_inside_root
+        return true if Nrb.inside?
+        fail_outside_root
+      end
+
+      private
+
+      def fail_outside_root
+        command = self.class.to_s.split('::').last
+
+        fail Nrb::OutsideRootError,
+          "You need to be inside a NinjaRuby folder to run the #{command} command."
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module Nrb
+  module Commands
+    class Resource < Commands::Inside
+      include ResourceGenerator
+
+      def self.valid_resources
+        arguments.find { |a| a.name == 'resource' }.enum
+      end
+
+      def ensure_valid_resource
+        return true if valid_resources.include? resource
+        fail_invalid_resource
+      end
+
+      private
+
+      def fail_invalid_resource
+        fail Nrb::InvalidResourceError,
+          "<resource> must be one of: #{valid_resources.join(', ')}."
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+require 'active_support/concern'
+
+module Nrb
+  module Commands
+    module ResourceGenerator
+      extend ActiveSupport::Concern
+
+      included do
+        argument :resource, type: :string, required: true,
+          desc:   'resource type',
+          banner: 'resource',
+          enum:   Nrb.config.resources.map(&:singularize)
+
+        argument :name, type: :string, required: true,
+          desc:   'name of the resource',
+          banner: 'name'
+      end
+
+      private
+
+      def target(final = nil)
+        File.join(File.expand_path(resource.pluralize), final.to_s)
+      end
+
+      def valid_resources
+        self.class.valid_resources
+      end
+    end
+  end
+end

data/lib/nrb/commands/console.rb

@@ -1,13 +1,15 @@
-require 'nrb/commands/inside_group'
-
 module Nrb
   module Commands
-    class Console < InsideGroup
-      desc_with_warning 'Jump into a Pry console with your project loaded'
+    class Console < Commands::Inside
+      desc 'Jump into a Pry console with your project loaded.'
+
+      class_option :pretend, default: false, type: :boolean,
+        desc: 'Pretend opening the console. Useful for testing.'
 
       def start
-        require_main_file
-        Pry.start
+        required = require_main_file
+        Pry.start unless options[:pretend]
+        required
       end
     end
   end

data/lib/nrb/commands/destroy.rb

@@ -1,41 +1,18 @@
-require 'nrb/commands/inside_group'
+require 'nrb/commands/concerns/resource_generator'
 
 module Nrb
   module Commands
-    class Destroy < InsideGroup
-      desc_with_warning "Destroy a generated resource"
+    class Destroy < Commands::Resource
+      desc 'Destroy a generated resource.'
 
-      argument :resource, type: :string, required: true,
-        desc: 'resource to destroy',
-        banner: 'RESOURCE',
-        enum: Nrb.config.directories.map(&:singularize)
-
-
-      argument :name, type: :string, required: true,
-        desc: 'name of the resource',
-        banner: 'NAME'
-
-      def valid_resource?
-        valid_resources = Nrb.config.directories.map(&:singularize)
-        return if valid_resources.include? resource
-        say "RESOURCE must be one of: #{valid_resources.join(', ')}."
-        exit
+      def destroy_resource
+        remove_file target("#{name.underscore}.rb"), opts
       end
 
-      def generate_resource
-        remove_file target("#{name.underscore}.rb")
-
-        # Also remove the *_create_resource migration
-        if resource == 'model'
-          migration_file = Dir["db/migrate/*create_#{name.underscore.pluralize}.rb"].first
-          remove_file migration_file if migration_file
-        end
-      end
-
-      private
-
-      def target(final = nil)
-        File.join(File.expand_path(resource.pluralize), final.to_s)
+      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
       end
     end
   end

data/lib/nrb/commands/generate.rb

@@ -1,48 +1,26 @@
-require 'nrb/commands/inside_group'
-
 module Nrb
   module Commands
-    class Generate < InsideGroup
-      desc_with_warning "Generate a resource (#{Nrb.config.directories.join(', ')})"
-
-      argument :resource, type: :string, required: true,
-        desc: 'resource to generate',
-        banner: 'RESOURCE',
-        enum: Nrb.config.directories.map(&:singularize)
-
-
-      argument :name, type: :string, required: true,
-        desc: 'name of the resource',
-        banner: 'NAME'
-
-      def valid_resource?
-        valid_resources = Nrb.config.directories.map(&:singularize)
-        return if valid_resources.include? resource
-        say "RESOURCE must be one of: #{valid_resources.join(', ')}."
-        exit
-      end
+    class Generate < Commands::Resource
+      desc "Generate a resource (#{valid_resources.join(', ')})."
 
       def generate_resource
         template "templates/#{resource}.rb.tt", target("#{name.underscore}.rb"),
-          name: name.camelize
+          opts.merge({ name: name.camelize })
       end
 
-      def create_table
-        return unless resource == 'model'
+      def generate_table
+        return false unless resource == 'model'
 
         migration_name = "create_#{name.underscore.pluralize}"
-        options = args.join(' ')
+        rake_options   = args.join(' ')
 
-        inside Nrb.root do
-          run "rake db:new_migration name=#{migration_name} options='#{options}'"
+        inside Nrb.root, opts do
+          Nrb.silently(opts) do
+            run "bundle exec rake db:new_migration name=#{migration_name} options='#{rake_options}'",
+              opts
+          end
         end
       end
-
-      private
-
-      def target(final = nil)
-        File.join(File.expand_path(resource.pluralize), final.to_s)
-      end
     end
   end
 end