cuba_genie 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ea6de37fd537e0cf2a0022b2c449fba4d4b95dd
-  data.tar.gz: 519edffa9fc41d3e2cd2474e7d13c4854e4feef8
+  metadata.gz: 50c305a2570c41d098bb165d2fa37aa63ff5a705
+  data.tar.gz: 285311530fdf6ed7f3410a898d5a8ce0055f9a84
 SHA512:
-  metadata.gz: 440620a683669ad330137c3dcdf041a9a4ce8e7ea7197c253179b6c6401f8c7605b95d7f49b91a489c068add9b848be01602aa620f7929f2e7481807f4a15196
-  data.tar.gz: 3f5d48e6d95fa781d99df3e9bacae3fb90dbc6bfd961f853030ad1469ce821855ddff6fb114c9a3e11eba759fc6223d087120ccd8ed7a3f8c74d2c485a7aac82
+  metadata.gz: 5977cf4d1319eca5dcad76270022543d5f8e06ec9379202b82c102a9d510cf221393de88a22c10a13c375ff57892fa5e2ad53e2b55e90836e6126b669d5c5150
+  data.tar.gz: 9839f7a3c762bdbab059a7edfcdfd778296cdab9194f1e56a5a704851cae05cbb169661a85767375c6c555c376b97f802214d978828b3c6c9439f28983d3927b

data/CHANGELOG.md

@@ -13,4 +13,8 @@
 
 -- Some serious code refactoring
 
+## 0.1.3 (2016-04-16)
 
+-- Don't have to implement #unexecute in command classes any longer, just set @rollback_msg 
+-- added git support
+-- enabled gem as embeddable, i.e. other gems can now incorporate their own functionality into CubaGenie code.

data/README.md

@@ -1,19 +1,20 @@
 # CubaGenie
 
-CubaGenie is a generator gem that sets up all the infrastructure you need in order to be immediately productive with the [Cuba](http://cuba.is/) web application. CubaGenie creates a skeleton Cuba app, configured to your preferences.
+CubaGenie is a generator gem that sets up all the infrastructure you need in order to be immediately productive with the [Cuba](http://cuba.is/) web micro-framework. CubaGenie creates a skeleton Cuba app, configured to your preferences.
 
 ## Why use it?
 
 [Cuba](http://cuba.is/) is a wonderful DSL that allows us to create simple web-apps quickly and easily. However, for more complex apps we would need to add extra functionality and components to the basic Cuba setup, things like view templates, data stores, static file serving, our favourite JS or CSS framework and so on. This can be a time-consuming task and it's not always obvious how to get everything working together. CubaGenie takes away the hassle by creating everything you need in one fell, quick swoop. 
 
 ## What does it create?
-1. A basic Cuba application ready to be ran (config, app-file and Gemfile)
-2. Ruby version management support files (.ruby-version and .ruby-gemset)
-3. Standard view templates (layout and home)
-4. A Minitest setup and basic functional test template (optional)
-5. A Capybara setup and basic acceptance test template (optional)
-6. A Rakefile with basic test tasks (optional)
-6. A Twitter Bootstrap installation, hooked into the view templates (optional)
+- A basic Cuba application ready to be ran (config, app-file and Gemfile)
+- Ruby version management support files (.ruby-version and .ruby-gemset)
+- Standard view templates (layout and home)
+- A .git folder (does `git init` in your project)
+- A Minitest setup and basic functional test template (optional)
+- A Capybara setup and basic acceptance test template (optional)
+- A Rakefile with basic test tasks (optional)
+- A Twitter Bootstrap installation, hooked into the view templates (optional)
 
 
 ## Installation
@@ -42,12 +43,78 @@ cuba_genie new <your_app_name>
 
 Then simply keep answering the questions CubaGenie asks you.
 
-## Development
+## Gem Development
 
 After checking out the repo, run `rake test` to run the tests. You can also run `rake 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).
 
+## Embedded Development
+
+CubaGenie is fully embeddable. This means you can incorporate its run-time in your own code and add your own generator commands to be ran in addition to the existing CubaGenie commands.  Embedding CubaGenie in your own code is very simple:
+
+### 1. include CubaGenie
+Add CubaGenie to your  *gemspec* file 
+
+	spec.add_dependency "cuba_genie"
+
+In your main gem file require CubaGenie
+
+
+	require "my_gem/version"
+	require 'cuba_genie'
+	
+	module MyGem
+	
+	end
+
+
+### 2. Setup CLI class
+
+Under your exe directory create a new file  *my_gem*. Make sure   *my_gem* has executable privileges, i.e. run `chmod 755 exe/my_gem`. The content of *my_gem* must be:
+
+
+	require 'cuba_genie'
+	
+	CubaGenie::MyCLI.start(ARGV)
+
+### 3. Add your command classes
+
+In your source files, open up the CubaGenie module and add your own command classes. A command class must:
+
+1. Derive from *Command* class
+2. Define a *PRECEDENCE* constant which sets the order in which the class will be executed (if more than one command classes are defined)
+3. Implement an initializer with a @*description* attribute which calls *super*.
+4. Implement the #*execute* method, passing a block to *super*.
+
+for instance,
+
+	module CubaGenie
+	  class MyClass < Command
+	    PRECEDENCE = 1 #this means this class will be ran before any others you define
+	
+	    def initialize
+	      @description = 'this is MyClass' #this will show when your class runs
+	      super
+	    end
+	
+	    def execute
+	      super do
+	        File.open('some_file', 'w') {|f| f.write("hello world!") }
+		    # if you create files or dirs maje sure you add them to @files_created and @dirs_created
+	        @files_created << "#{Dir.pwd}/'some_file'"
+	        puts "********** executin class A"
+	      end
+	    end
+	
+	  end
+	end
+	
+### 4. Build and run your gem
+`bundle install && bundle exec rake install` will build and install your gem locally. `my_gem new my_project_name` will run all the  CubaGenie generators and will then run your own generator classes in the order specified by PRECEDENCE. Happy days!
+
+
+
 ## Roadmap
 
 * Add RSpec support

data/lib/cuba_genie.rb

@@ -27,6 +27,10 @@ module CubaGenie
       @cmds.add_command CubaSetup.new(project_name: project_name, minitest: minitest, capybara: capybara)
       @cmds.add_command ViewsSetup.new(project_name: project_name, bootstrap_version: choose_bootstrap_version)
       @cmds.add_command MinitestSetup.new(project_name: project_name, reporter: reporter, capybara_setup: capybara) if minitest
+      
+      # allow users to add their own commands
+      run_extensions
+
       puts closing_message(project_name) if @cmds.execute
     end
 
@@ -65,6 +69,15 @@ module CubaGenie
 
     private
 
+
+    # Prompts the user for a boolean input, within a range of potential
+    # semantically true or false values (POSITIVE_RESPONSES, NEGATIVE_RESPONSES)
+    #
+    # @param N/A
+    #
+    # @return [Boolean] a true or false value
+    #
+    #
     def ask_for_yes_no_response
       response = STDIN.gets.chomp
       while !(POSITIVE_RESPONSES + NEGATIVE_RESPONSES).include? response
@@ -82,10 +95,10 @@ module CubaGenie
     #
     # @return [Fixnum] an integer within the valid range
     #
-    # @note character 0 cannot be used as a range value. The reason is that 
+    # @note character 0 cannot be used as a range value. The reason is that
     # #to_i will convert any non-numberic character to 0, which the method will
     # then wrongly interpret as a valid character
-    #    
+    #
     def ask_for_numeric_reponse(valid_range)
       response = STDIN.gets.chomp.to_i
       while !valid_range.cover? response
@@ -96,10 +109,62 @@ module CubaGenie
       response
     end
 
+
+    # Gets all Command-derived classes defined in the CubaGenie
+    # module and filters out the classes already defined by the
+    # core CubaGenie gem. What is left are the classes added as
+    # user-extensions to the gem, and which will be run after the 
+    # built-in commands have ran.
+    #
+    # @param N/A
+    #
+    # @return [Array<Symbol>] all user-added Command-derived classes 
+    #
+    #
+    def get_extensions
+      existing_klasses = [:CubaSetup, :MinitestSetup, :ViewsSetup]
+      all_command_klasses = CubaGenie.constants.select do |c|
+        Class === CubaGenie.const_get(c) && CubaGenie.const_get(c).superclass == CubaGenie::Command
+      end
+      all_command_klasses - existing_klasses
+    end
+
     def closing_message(project_name)
-      "\nYour #{project_name} Cuba app is now set up and ready to go! To start the app, cd into #{project_name} directory, run 'bundle install' and then 'rackup'. You can then see your app running on 'http://localhost:9292'."
+      "\nYour #{project_name} Cuba app is now set up and ready to go! To start the app, cd "\
+        "into the #{project_name} directory, run 'bundle install' and then 'rackup'. You can then "\
+        "see your app running on 'http://localhost:9292'."
     end
 
 
+    # Gets all user-defined Command-derived classes within the 
+    # CubaGenie module, order them according to their PRECEDENCE
+    # constant and adds them to the command-list so that they can 
+    # be executed after the built-in CubaGenie classes
+    #
+    # @param N/A
+    #
+    # @return [Array<Symbol>] all user-added Command-derived classes 
+    #
+    #
+    def run_extensions
+      # first check if someone added extension classes in our module
+      command_classes = get_extensions
+      unless command_classes.empty?
+        #order classes in order of precedence
+        command_classes.sort_by! do |item|
+          CubaGenie.const_get(item).const_get(:PRECEDENCE)
+        end
+
+        command_classes.each do |klass|
+          if CubaGenie.const_get(klass).instance_methods.include? :execute
+            @cmds.add_command CubaGenie.const_get(klass).new
+          else
+            # #execute method is not implemented
+            ## TODO: raise exception?
+          end
+        end
+      end
+    end
+
   end #class
 end #module

data/lib/cuba_genie/command.rb

@@ -1,13 +1,35 @@
 module CubaGenie
+# Implements the Command pattern. Responsible for providing execute
+# and unexecute (rollback) methods. Every Command-derived class must
+# implement an #execute methods which passes a block to super and
+# (optionally) an unexecute method 
 
+#
   class Command
 
-    attr_reader :description, :error, :project_name
+    attr_reader :description, #what this class does
+                :error, #fill-in if things go wrong
+                :rollback_msg, #what to display if we roll-back
+                :project_name
+
 
     def initialize(**args)
+      # arrays used to keep track of files created, so that they
+      # can be rolled back, if needed
       @files_created, @dirs_created = [], []
     end
 
+
+    # Yields to a block where the user puts their command code 
+    #
+    # @param N/A
+    #
+    # @return [Boolean] true if methods runs without problems,
+    # false if an exception is raised
+    #
+    # @note any files or directories created here should have their
+    # path pushed to @files_created and @dirs_created arrays.
+    #
     def execute
       yield
       true
@@ -15,8 +37,18 @@ module CubaGenie
       puts e.message and false
     end
 
-    def unexecute(message)
-      puts message unless ENV['RACK_ENV'] == 'test'
+
+    # Deletes all files and directories created with the execute
+    # method.
+    #
+    # @param N/A
+    #
+    # @return [Boolean] true if methods runs without problems,
+    # false if an exception is raised
+    #
+    #
+    def unexecute
+      puts @rollback_msg unless ENV['RACK_ENV'] == 'test'
       @files_created.each do |file_path|
         File.delete file_path if File.exist? file_path
       end

data/lib/cuba_genie/command_list.rb

@@ -37,7 +37,10 @@ class CommandList
 
   private
   def unexecute(idx)
-    @commands.slice(0, idx + 1).reverse_each(&:unexecute)
+    @commands.slice(0, idx + 1).reverse_each do |cmd| 
+      cmd.rollback_msg
+      cmd.unexecute
+    end
   end
 
   alias_method :size, :length

data/lib/cuba_genie/cuba_setup.rb

@@ -12,6 +12,7 @@ module CubaGenie
       @minitest = args[:minitest]
       @capybara = args[:capybara]
       @description = "Creating Cuba setup"
+      @rollback_msg = "rolling back Cuba basic setup"
       super
 
     end
@@ -24,16 +25,13 @@ module CubaGenie
         create_app_file
         create_rack_file
         create_gem_file
+        git_initialize
         create_ruby_version_file
         create_ruby_gemset_file
       end
     end
 
 
-    def unexecute
-      super("rolling back Cuba basic setup")
-    end
-
     private
 
     def create_app_file
@@ -75,5 +73,9 @@ module CubaGenie
       %x(ruby -v).slice(/(\d\.){2}\d/)
     end
 
+    def git_initialize
+      %x(git init)
+    end    
+
   end #class
 end #module

data/lib/cuba_genie/minitest_setup.rb

@@ -14,6 +14,7 @@ module CubaGenie
       @description = (args[:capybara_setup] ?
                       "Setting up Minitest functional and acceptance tests" :
                       "Setting up Minitest functional tests")
+      @rollback_msg = "rolling back Minitest"
       @capybara_setup = args[:capybara_setup]
       @project_name = args[:project_name]
       @reporter = args[:reporter] || 'Default'
@@ -37,11 +38,6 @@ module CubaGenie
     end
 
 
-    def unexecute
-      super("rolling back Minitest")
-    end
-
-
     private
     def create_test_helper
 

data/lib/cuba_genie/version.rb

@@ -1,3 +1,3 @@
 module CubaGenie
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/cuba_genie/views_setup.rb

@@ -19,6 +19,7 @@ module CubaGenie
       @project_name = args[:project_name]
       #TODO: allow for choice of different template engines
       @description = 'Setting up views'
+       @rollback_msg = "rolling back Views"
       @bootstrap_version = args[:bootstrap_version] || 'n'
       super
     end
@@ -38,10 +39,6 @@ module CubaGenie
       end
     end
 
-    def unexecute
-      super("rolling back views")
-    end
-
 
     private
     def create_view_files(layout_view_formatters)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cuba_genie
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Fred Heath
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-13 00:00:00.000000000 Z
+date: 2016-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -203,7 +203,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: CubaGenie is a generator gem that sets up all the infrastructure you need