gennifer 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d1b3a8efd28b28d53e021452d16636c554e4ece1
-  data.tar.gz: b896d069ea8db92c0fab2fc33f20d07831452145
+  metadata.gz: f5a475dbd8aeb00c1cb876e28fc3b9ddca18901f
+  data.tar.gz: 5d224b6a60292c9b5c0e6f37c7420145e3e4d791
 SHA512:
-  metadata.gz: 298caf3c9387282d75b39541e74ff91e3a5cfb1153ac6d2913a60652fefdf6d679af80b51e1b7507dc1ce5af8bfd61694b3a141a8af714e3f24ef00c9ee28ab4
-  data.tar.gz: 0f118da76da19d189535f5900e33cc09bb13d3bd052d560de605277a35c921bd3959ca51c3b5f42262c2e03814b9bb3cc0828eccccf7ceeafeecc7e692145797
+  metadata.gz: 4c39cb6f29792b22c8a0edd131bc0bca5644e72a983c2d16e3a9c646702d636731348416a21f66193af98398158c1c1b807b16364b6e08491c6b1c57786fe211
+  data.tar.gz: a472a1e5d7c24f340fc2b73d0c80d2d786deb91b19398994c64de729a3158732522f20b46549290816c7e8064a307cd97d603a602f457d6c58c74e47aa48e117

data/README.md

@@ -8,7 +8,8 @@ To install the gem:
 
     $ gem install gennifer
 
-To put default settings in the folder ~/.gennifer
+You need some recipes to use gennifer. Before writing your own recipe, you are highly recommended to install the default settings and recipes. 
+To put default settings and recipes in the folder ~/.gennifer
 
     $ gen install
 
@@ -82,8 +83,9 @@ be in the following format.
       end
     end
 
-Apart from coding the whole recipe using ruby (like using mkdir, cp, mv in
-FileUtils), there are several method you can use in the recipe. For example,
+You may write the whole recipe using ruby (like using mkdir, cp, mv in
+FileUtils). However, there are several convenient helper methods you can 
+use in the recipe. For example,
 `create` will create a new directory in the target location if only the location
 is specified. And it will copy a file/directory
 from the resources folder if a resources location is specified in the second

data/default/recipes/after_recipe.rb

@@ -1,9 +1,21 @@
 class AfterRecipe
   def recipe
-    executable @full_path if check_argv('exe')
-    `#{Settings::EDITOR} #{@full_path}` if check_argv('edit')
+    executable @full_path if (check_argv('-exe') or check_argv('-e'))
 
-    if check_argv('bin') then
+    `#{Settings::EDITOR} #{@full_path}` if check_argv('-edit')
+
+    `#{Settings::EDITOR} #{@full_path}` if (check_argv('-open') or check_argv('-o'))
+
+    if (check_argv('-bin') or check_argv('-b')) then
+      new_location= File.expand_path(Settings::BINFOLDER + '/' + @full_name)
+      if File.exists?(new_location)
+        FileUtils.rm_rf(@full_path)
+      else
+        FileUtils.mv(@full_path , new_location)
+      end
+    end
+
+    if check_argv('-ebo') then
       new_location= File.expand_path(Settings::BINFOLDER + '/' + @full_name)
       if File.exists?(new_location)
         FileUtils.rm_rf(@full_path)

data/default/recipes/article.rb

@@ -10,4 +10,12 @@ class ArticleRecipe
     create (@full_path + "/figures/sample-figure.pdf"), 'sample-figure.pdf'
 
   end
+
+  def example
+  	'gen MyProjectName article'
+  end
+  
+  def explanation
+  	'generate a latex article project'
+  end
 end

data/default/recipes/beamer.rb

@@ -10,4 +10,14 @@ class BeamerRecipe
     create (@full_path + "/figures/sample-figure.pdf"), 'sample-figure.pdf'
 
   end
+
+
+  def example
+  	'gen MyProjectName beamer'
+  end
+  
+  def explanation
+  	'generate a latex beamer project'
+  end
+
 end

data/lib/gennifer.rb

@@ -2,10 +2,25 @@ require "gennifer/version"
 require 'fileutils'
 require 'erb'
 
+
+
 # TODO: command to generate new recipes with commented hint/tutorial
 # TODO: write tests and test in windows
 # TODO: better treatment for duplicate files in bin folder
-# TODO: put help text in recipe and make the help command auto read it
+# TODO: put help text in recipe and make the help command auto read it (can add an option to show verbose help or short help).... One way to do it is to add a method "help_text" to each recipe file. Probably should not show all the help text in every recipe every single time. Just hsow all of them when the user do "gen help all". (Advise them "gen help all" when they just do "gen help" or just type "gen")
+# TODO: help text when the project type is available but with no name, say "gen article" should show the help text of article  (current behaviour is to generate a article project with name article, which is strange)
+
+
+# TODO: write a lot richer default recipe (at least it should support more file extension names)
+# TODO: better advide when gennifer is installed but there is no settings file (or the settings files is not in the correct format)
+# TODO: show help text or show better instructions (instead of 'recipe not found") when gen is run but no recipe is matached. (presumably this is the case of typo or wrong syntax)
+# TODO: consider adding convention such as underscore before project type
+# TODO: make the arguments available to the receipe as a hash. So that one can use erb to get the argument and generate more complicated files.
+# TODO: better "bin recipe", moving the file to bin folder after create mey not be the best solution because it handle duplicate files poorly (or I can improve the afterrecipe to take into accoount those situation, or may a helper method)
+
+
+
+
 
 module Gennifer
   def self.gen(argv)
@@ -36,6 +51,7 @@ module Gennifer
 
 
     if (argv0 == 'help' or argv0 == '') then
+      help_text_old(argv1)
       help_text(argv1)
     else
       recipe_class = get_recipe_class(argv1)
@@ -83,6 +99,23 @@ module Gennifer
   end
 
   def self.help_text(argv1)
+    padding = "
+      "
+    puts "#{padding}More help text..........(under construction)"
+
+
+    recipe_class = get_recipe_class(argv1)
+    if recipe_class then
+      #puts "#{padding}Show help text for #{recipe_class}"
+      puts "#{padding}#{recipe_class.new.example}         #{recipe_class.new.explanation}"
+    else
+      puts "#{padding}Show general help text"
+    end
+
+
+  end
+
+  def self.help_text_old(argv1)
 
     if argv1 == 'install' then
       puts "
@@ -108,7 +141,8 @@ module Gennifer
       "
     else
       puts "
-      gen install                   install the default settings and recipe
+
+      gen install                   install the default settings and recipes
       gen myproject article         generate a latex article project
       gen myproject exam            generate a latex exam project
       gen myproject letter          generate a latex letter project
@@ -118,6 +152,8 @@ module Gennifer
       gen myfile.rb bin             generate a ruby file and make it executable,
                                     move the file to the bin folder and use the
                                     editor to open the file.
+      gen myfile py                 generate a python file with name myfile
+
       "
     end
   end

data/lib/gennifer/version.rb

@@ -1,3 +1,3 @@
 module Gennifer
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gennifer
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Chungsang Tom Lam
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-18 00:00:00.000000000 Z
+date: 2016-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler