cogy 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28ec300393c739ebc8a9f7b3d84fb9934e8f9778
-  data.tar.gz: b685e1a2685d49340dbadf54550375a9689d2ac8
+  metadata.gz: 0dc60289e97c5f49e30bfd90581fe24743fc04c6
+  data.tar.gz: 422827094a27717584a27c0f2e1812cd7297811f
 SHA512:
-  metadata.gz: 90b69b70b3b6a243ff59c6bf7ec4ea8f1c0e8ed6a88a9ea5b0579126c78e34a574379975ebcbdc3ee8a0ff54f40b5609893fcad0ee0bf2b72160712cb6ab7f9e
-  data.tar.gz: a944b9dafce7515bdf84a95547228ba832b11dfc1d02ce40ab16c136005ca7be0930f3022fcc2d384ff9c833cf79211b5897ad39afa2d896416083ac3a314643
+  metadata.gz: a21ad7aa25394ee9eeeb6423f49ad6c122c82a7ed4efce6e81d8704da2bf69850a03ddb69d0bf67b7c6f00b4e042980272c51c4828b754853d27b81a8fc83d7a
+  data.tar.gz: 9c5f3b2626f38622200600577c4f20fc59510414455b5e0db88d32b6e6cccc4f01b4777700fd4673d62e35949d35ce832b305df610056038967cb3e31d430d75

data/README.md

@@ -1,36 +1,52 @@
 # Cogy
 
-Cogy provides a way to integrate Cog with Rails apps, in a way that managing
-and adding commands is a breeze.
+Cogy integrates [Cog](https://operable.io/) with Rails
+in a way that managing commands becomes a breeze.
+
+## Status
+
+*DISCLAIMER*: While we use Cogy in production, it's still in public alpha and
+is under heavy development.
+
+This means that a few critical bits are missing (the Relay executable and
+RSpec helpers to name a few) and the API is not stable yet.
+
+However, feel free to test it and gives us your feedback!
 
 ## Why
 
-Creating a command that talks with a Rails app, typically involves writing
+Creating a Cog command that talks with a Rails app typically involves writing
 a route, maybe a controller, an action and code to handle the command arguments
 and options.
 
-This is a repetitive task and Cogy provides a way to get rid of this tedious
-boilerplate code.
+This is a tedious and repetitive task and involves writing a lot of boilerplate
+code each time someone wants to add a new command.
+
+Cogy is an opinionated library that provides a way to get rid of all the
+repetitive work and makes writing commands a breeze!
 
-With Cogy, writing a new command is as simple as adding the following line
+Making a new command available for use is as simple as adding the following line
 to a file in your application:
 
 ```ruby
 # in cogy/my_commands.rb
 
-on "foo", desc: "Echo a foo bar back at you!" do |req_args, _, user|
+on "foo", desc: "Echo a foo bar back at you!" do |_args, _opts, user|
   "@#{user}: foo bar"
 end
 ```
 
+...and deploying!
+
 ## How it works
 
 Cogy is essentially three things:
 
-1. An opinionated way to build commands: All Cogy commands are defined in your
-   Rails app and end up in a single executable within the Relay (see below).
-   Cogy provides versioning and dynamically generates the bundle config, which
-   is also served by your Rails app. This, accompanied with the command [TODO: INSERT LINK HERE] that
+1. An opinionated way to write, manage & ship commands: All Cogy commands are
+   defined in your Rails app and end up invoking a single executable within the
+   Relay (see below). Cogy provides versioning and dynamically generates the
+   bundle config, which is also served by your Rails app (via a Rails Engine).
+   This, accompanied with the command [TODO: INSERT LINK HERE] that
    can install bundles from other bundles, makes it possible to automatically
    install the newly-written commands by invoking a trigger when you deploy
    your app.
@@ -120,7 +136,7 @@ on "calc",
   args: [:a, :b],
   opts: { op: { type: "string", required: true, short_flag: "o" } },
   desc: "Performs a calculation between numbers <a> and <b>",
-  example: "!myapp:calc sum 1 2" do |req_args, req_opts, user|
+  examples: "!myapp:calc sum 1 2" do |req_args, req_opts, user|
   op = req_opts[:op].to_sym
   result = req_args.map(&:to_i).inject(&op)
   "Hello @#{user}, the result is: #{result}"
@@ -144,11 +160,9 @@ However it can be overriden in the application by creating a view in
 ## Authors
 
 * [Agis Anastasopoulos](https://github.com/agis-)
+* [Mpampis Kostas](https://github.com/charkost)
 
 ## License
 
 Cogy is licensed under MIT. See [LICENSE](LICENSE).
 
-
-
-

data/lib/cogy/command.rb

@@ -1,14 +1,14 @@
 module Cogy
   class Command
-    attr :name, :args, :opts, :desc, :long_desc, :example, :rules, :handler
+    attr :name, :args, :opts, :desc, :long_desc, :examples, :rules, :handler
 
-    def initialize(name, args: [], opts: {}, desc:, long_desc: nil, example: nil, rules: nil)
+    def initialize(name, args: [], opts: {}, desc:, long_desc: nil, examples: nil, rules: nil)
       @name = name
       @args = [args].flatten.map!(&:to_s)
       @opts = opts.with_indifferent_access
       @desc = desc
       @long_desc = long_desc
-      @example = example
+      @examples = examples
       @rules = rules || ["allow"]
     end
 

data/lib/cogy/version.rb

@@ -1,3 +1,3 @@
 module Cogy
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/cogy.rb

@@ -10,8 +10,8 @@ module Cogy
   @@commands = {}
 
   # Bundle config-related stuff
-	mattr_accessor :bundle_name
-	@@bundle_name = "cogy"
+  mattr_accessor :bundle_name
+  @@bundle_name = "cogy"
 
   mattr_accessor :bundle_description
   @@bundle_description = "Cogy-generated commands"
@@ -74,8 +74,8 @@ module Cogy
         config["commands"][name]["long_description"] = cmd.long_desc
       end
 
-      if cmd.example
-        config["commands"][name]["example"] = cmd.example
+      if cmd.examples
+        config["commands"][name]["examples"] = cmd.examples
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cogy
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Agis Anastasopoulos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-02 00:00:00.000000000 Z
+date: 2016-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails