ruby_storm 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c06018e1d6a54f78c31e57ed3a5918055e4ff199
-  data.tar.gz: b311afdb1736da058089f5db3707fd5992088d6b
+  metadata.gz: 5c7e6151c5ed4d97e2d7dc22b9b2f2d2878c91d0
+  data.tar.gz: 350cf19b627ea46f0356b3f75add71d455ae0552
 SHA512:
-  metadata.gz: c2565e54e23409298295b49b4f67b714319e6b7784bd08ec3e51ae214a4fcbab3d754b6c72bad5c44afdfb71c9a26f29d6c9341387638d29534102568e841210
-  data.tar.gz: f00c5ac8a06e5b19f64cc92f473ec39665766c2b6729cba0c289305e95c4031899dca3953251add30c68ce14debcb69a4deb5f3fb7b5efb0e459611c1b85433e
+  metadata.gz: 483ccedac53f7f5b6648d3c3e1b404f4dc63c38ecd29ac876247a14b77412d8d68056496cc290ea01b4c6dc36162d4f36005c25a5b93eceaa7cbe703b016b65f
+  data.tar.gz: 8c4ead33b151c54b1652e70239cf59cc3b4731adc7edb3fc8149e577ba45ac19976189d0ef5be8c1483611011868978ba7710ff9c912f82f3b246b4f00ca0bad

data/README.md

@@ -1 +1,84 @@
-Ruby Storm
+[![Ruby Storm](https://img.shields.io/badge/Ruby Storm-Ruby%20Stand%20alone%20object%20relational%20mapper-blue.svg)](Ruby Storm)
+[![Gem Version](https://badge.fury.io/rb/ruby_storm.svg)](http://badge.fury.io/rb/ruby_storm)
+[![Downloads](https://img.shields.io/gem/dt/ruby_storm/stable.svg)](https://img.shields.io/gem/dt/ruby_storm)
+[![Inline docs](http://inch-ci.org/github/wouterken/ruby_storm.svg?branch=master)](http://inch-ci.org/github/wouterken/ruby_storm)
+
+### Ruby Storm
+
+Ruby Storm is a light-weight  **st**and-alone ***o***bject **r**elational **m**apper wrapping the functionality of the Rails active record library into a light-weight tool.
+
+You can use ruby storm to generate minimal applications with full support for active-record, migrations, basic model generation and an interactive console.
+
+#### Installation
+
+```ruby
+gem install ruby_storm
+```
+
+#### Usage
+
+* Generating a new project
+
+````
+storm init my_new_project
+cd my_new_project
+````
+* Generating a new model (and migration in a project)
+
+````
+storm db:generate MyModel first_name:string last_name:string order:integer happy:boolean
+````
+* Performing migrations
+
+```
+storm db:migrate
+```
+
+* Rollbacks
+
+```
+storm db:rollback
+STEP=5 storm db:rollback
+```
+* Version
+
+```
+storm db:version
+```
+
+* Update existing models
+
+```
+storm db:modify MyModel
+```
+
+### Storm console
+The storm console can be started from the project root directory and will auto-load all of your storm models.
+
+```
+storm console
+```
+
+### Storm application
+You storm app can function as a traditional c-style application and has a 'main' entry point in the generated application file.
+You can start your storm app by executing the following from the project directory.
+
+```
+storm start
+```
+
+### Tasks
+You can add additional tasks to your storm application similar to Rake tasks.
+In the application file add a class function with the name of the task you wish to add. You can then execute that task from the command line with an optional number of arguments.
+
+```ruby
+## In main app file.
+def self.my_task(args)
+  print args
+end
+
+## From command line
+storm app my_task arg1 arg2
+
+# Outputs => ["arg1", "arg2"]
+```

data/generators/console.rb

@@ -25,6 +25,7 @@ module Storm
       begin
         require 'pry'
         Pry.color = true
+        Pry.config.print = proc { |output, value| output.puts "=> #{value.ai}" }
         load Gem.bin_path('pry', 'pry')
       rescue Exception => e
         if @@reload

data/generators/version.rb

@@ -1,7 +1,7 @@
 module Storm
   class Version
     def self.to_s(*args)
-      "0.0.8"
+      "0.0.9"
     end
 
     def self.start(*args)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_storm
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Wouter Coppieters