gennifer 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff35e3df1f794dec0816d0842cb897efae5d4850
-  data.tar.gz: 057739a7c096baf25645f5b28d13c3167c60b939
+  metadata.gz: d1b3a8efd28b28d53e021452d16636c554e4ece1
+  data.tar.gz: b896d069ea8db92c0fab2fc33f20d07831452145
 SHA512:
-  metadata.gz: 5586c6bd0864224a559874b1c21afb3573ae47469df1549ed6c1ae2c7da25ac09ca749180f9b85e944fa478256d8313a39866a5d141f0237829e07f8a706d96a
-  data.tar.gz: 0c45264f82d24d98bf8b8fecd7a6a165fa1a34e221f93bdc70c77f81784b16800220eb6a8429df6e9da17397612f450c7feadcd5a9975f3c27476bf16abaf49d
+  metadata.gz: 298caf3c9387282d75b39541e74ff91e3a5cfb1153ac6d2913a60652fefdf6d679af80b51e1b7507dc1ce5af8bfd61694b3a141a8af714e3f24ef00c9ee28ab4
+  data.tar.gz: 0f118da76da19d189535f5900e33cc09bb13d3bd052d560de605277a35c921bd3959ca51c3b5f42262c2e03814b9bb3cc0828eccccf7ceeafeecc7e692145797

data/README.md

@@ -1,41 +1,178 @@
 # Gennifer
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/gennifer`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This is a gem for generating files or projects using recipes and templates. Everything is done by a simple command 'gen'
 
 ## Installation
 
-Add this line to your application's Gemfile:
+To install the gem:
 
-```ruby
-gem 'gennifer'
-```
+    $ gem install gennifer
 
-And then execute:
+To put default settings in the folder ~/.gennifer
 
-    $ bundle
+    $ gen install
 
-Or install it yourself as:
+## Basic Usage
 
-    $ gem install gennifer
+The gem is customizable but it also comes with a bunch of default functionality
+out of the box.
 
-## Usage
+To generate a latex article project (with the tex file, the bib file, the figure folder, and .gitignore file):
 
-TODO: Write usage instructions here
+    $ gen project_name article
 
-## Development
+To generate a latex beamer project instead:
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+    $ gen project_name beamer
 
-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).
+Or just a simple tex file:
 
-## Contributing
+    $ gen file_name.tex tex
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/gennifer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+To generate a sublime-project file in the current folder to make the current folder a sublime text project:
 
+    $ jem project_name sublime
 
-## License
+To generate a ruby file with the name testing.rb :
+
+    $ gen testing.rb ruby
+
+To generate a python file with the name testing.py :
+
+    $ gen testing.py python
+
+In fact gennifer would recognize the extension name so that
+
+    $ gen testing.rb
+    $ gen testing.py
+
+also work as expected.
+
+To see the help text:
+
+    $ gen help
+
+## Advanced Usage
+
+### Settings
+
+If you have tried `gen project_name article`, you probably notice that the file
+contain names and information of the author. The default name is Gennifer Lynn
+Connelly and there are default values for other information too. You can change
+the values in the file ~/.gennifer/settings.rb. The system settings are those
+settings which will alter the behaviour of the program. And the users Settings
+are variables which is available in the recipes. 
+
+### Make your own recipes
+
+All the recipes are stored in the folder ~/.gennifer/recipes. Each files
+contains a recipe which can be used with the command `gen`. Each recipe should
+be in the following format.
+
+
+    class ArticleRecipe
+      def recipe
+        create @full_path
+        create (@full_path + "/#{@full_name}.tex"), 'latex_article.tex'
+        erb (@full_path + "/#{@full_name}.tex")
+        create (@full_path + "/reference.bib"), 'reference.bib'
+        create (@full_path + "/.gitignore"), 'gitignore_latex'
+        create (@full_path + '/figures')
+        create (@full_path + "/figures/sample-figure.pdf"), 'sample-figure.pdf'
+      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,
+`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
+argument.
+
+A bunch of variables are available in the recipe. For example, if you run
+`gen myarticle article` from the location ~/Document/projects/, then
+
+    @current_dir   # ~/Document/projects/
+    @resources     # ~/.gennifer/resources/
+    @full_name     # myarticle
+    @base_name     # myarticle
+    @ext_name      #
+    @recipe        # ArticleRecipe
+    @target_dir    # ~/Document/projects/
+    @full_path     # ~/Document/projects/myarticle/
+
+If you run `gen ../myfile.rb` from the location ~/Document/projects/, then
+
+    @current_dir   # ~/Document/projects/
+    @resources     # ~/.gennifer/resources/
+    @full_name     # myfile.rb
+    @base_name     # myfile
+    @ext_name      # .rb
+    @recipe        # RbRecipe
+    @target_dir    # ~/Document/
+    @full_path     # ~/Document/myfile.rb
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
+The class name should be in capitalized camelcase and ended with the word
+Recipe. For example, the command `gen project_name article` will invoke the
+recipe `ArticleRecipe`.
+
+The file name and file structure inside the folder ~/.gennifer/recipes are not
+important. You can use the folder structure to organize the recipes.
+
+### Recipe by file names
+
+When the recipe is not specifed, gennifer will use the file name to try to
+identify the recipe. For example,
+
+    $ gen cat.rb
+
+Gennifer will try the recipes in the following order: CatRbRecipe, RbRecipe, CatRecipe. Among the default recipes, the RbRecipe would be used. A more
+complicated example would be
+
+    $ gen application.html.erb
+
+Gennifer will try the recipes in the following order: ApplicationHtmlErbRecipe,
+HtmlErbRecipe, ErbRecipe, HtmlRecipe, ApplicationRecipe.
+
+If everything tried and still there is no recipe found, Gennifer will use the
+DefaultRecipe. This recipe is specified in the file ~/.gennifer/recipes/default.rb
+
+
+### Special recipes
+
+Among all the recipes, there are three of them which are special. The
+AfterRecipe, BeforeRecipe, and DefaultRecipe. As mentioned before, the
+DefaultRecipe is the recipe which is called when no suitable recipe is found
+for a certain file/project name. The BeforeRecipe is the recipe which is run
+before any recipes and the AfterRecipe is run after any recipes.
+
+
+### Other arguments
+
+You can supply extra arugments to the `gen` command to customize the behaviour
+of each recipe. All extra arguments are available in the recipe. For example,
+
+    $ gen testing.rb exe
+
+will generate a testing.rb file and make the file executable. This is specified
+in the first line of the AfterRecipe (`executable @full_path if check_argv('exe')`). The part `check_argv('exe')` check whether `exe` is
+included in the arguments and it can be used to check for other extra arguments.
+
+
+### ERB support
+
+You can use the method erb in recipe (see ArticleRecipe). This will use erb to
+process the file before it is generated. Gennifer uses erb to fill in
+information like name and address using the information specified in the
+settings.rb.
+
+### Combining multiple recipes
+
+You can invoke another recipe by using `invoke(TargetRecipe)` in the recipe
+file. Notice that the program wont stop if you recursively invoke the same
+recipe from itself.
+
+## License
+
+This gem is not released for public use yet.

data/default/recipes/after_recipe.rb

@@ -0,0 +1,20 @@
+class AfterRecipe
+  def recipe
+    executable @full_path if check_argv('exe')
+    `#{Settings::EDITOR} #{@full_path}` if check_argv('edit')
+
+    if check_argv('bin') 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
+      executable new_location
+      `#{Settings::EDITOR} #{new_location}`
+    end
+
+    puts(@full_name + ' generation finished') if Settings::VERBOSE
+    
+  end
+end

data/default/recipes/article.rb

@@ -0,0 +1,13 @@
+
+class ArticleRecipe
+  def recipe
+    create @full_path
+    create (@full_path + "/#{@full_name}.tex"), 'latex_article.tex'
+    erb (@full_path + "/#{@full_name}.tex")
+    create (@full_path + "/reference.bib"), 'reference.bib'
+    create (@full_path + "/.gitignore"), 'gitignore_latex'
+    create (@full_path + '/figures')
+    create (@full_path + "/figures/sample-figure.pdf"), 'sample-figure.pdf'
+
+  end
+end

data/default/recipes/beamer.rb

@@ -0,0 +1,13 @@
+
+class BeamerRecipe
+  def recipe
+    create @full_path
+    create (@full_path + "/#{@full_name}.tex"), 'latex_beamer.tex'
+    erb (@full_path + "/#{@full_name}.tex")
+    create (@full_path + "/reference.bib"), 'reference.bib'
+    create (@full_path + "/.gitignore"), 'gitignore_latex'
+    create (@full_path + '/figures')
+    create (@full_path + "/figures/sample-figure.pdf"), 'sample-figure.pdf'
+
+  end
+end

data/default/recipes/before_recipe.rb

@@ -0,0 +1,5 @@
+class BeforeRecipe
+  def recipe
+    puts('Generating ' + @full_name) if Settings::VERBOSE
+  end
+end

data/default/recipes/cpp.rb

@@ -0,0 +1,6 @@
+
+class CppRecipe
+  def recipe
+    create @full_path, 'cpp_file.rb'
+  end
+end

data/default/recipes/cppmake.rb

@@ -0,0 +1,9 @@
+
+class CppMakeRecipe
+  def recipe
+    create @full_path
+    create (@full_path + "/#{@full_name}.cpp"), 'cpp_file.cpp'
+    create (@full_path + "/Makefile"), 'Makefile'
+    create (@full_path + "/.gitignore"), 'gitignore_basic'
+  end
+end

data/default/recipes/default.rb

@@ -0,0 +1,5 @@
+class DefaultRecipe
+  def recipe
+    create @full_path, "default"
+  end
+end

data/default/recipes/exam.rb

@@ -0,0 +1,8 @@
+
+class ExamRecipe
+  def recipe
+    create @full_path
+    create (@full_path + "/#{@file_name}.tex"), 'latex_exam.tex'
+    create (@full_path + "/.gitignore"), 'gitignore_latex'
+  end
+end

data/default/recipes/example.rb

@@ -0,0 +1,33 @@
+
+class ExampleRecipe   # This is the name of the recipe, it's in Capitalized CamelCase ended with 'Recipe'. This recipe can be invoked by 'jen FILENAME example'.
+  def recipe  # every recipe file must containt the method 'recipe'.
+    # put the code which generates the files here. Here is a list of helper methods:
+
+
+    # To make new directory:
+      # create DIRECTORY_NAME
+    # To copy directory from resources:
+      # create "#{@target_dir}/DIRECTORY_NAME", "RESOURCES_NAME"
+    # To copy file from resources:
+      # create (@target_dir + "/FILE_NAME"), "RESOURCES_NAME"
+    # To invoke another recipe
+      # invoke(AnotherRecipe)
+    # To evaluate the file using erb
+      # erb(FILENAME)
+    # To get whether a word is in the argument or new_location
+      # check_argv(WORD)
+    # To make a file executable
+      # executable FILENAME
+
+    # Here are the available variables
+      # @current_dir
+      # @resources
+      # @full_name
+      # @base_name
+      # @ext_name
+      # @recipe
+      # @target_dir
+      # @full_path
+
+  end
+end

data/default/recipes/html.rb

@@ -0,0 +1,6 @@
+
+class HtmlRecipe
+  def recipe
+    create @full_path, 'sample_html.html'
+  end
+end

data/default/recipes/htmlerb.rb

@@ -0,0 +1,6 @@
+
+class HtmlErbRecipe
+  def recipe
+    create @full_path, 'sample_html.html'
+  end
+end

data/default/recipes/letter.rb

@@ -0,0 +1,12 @@
+
+class LetterRecipe
+  def recipe
+    create @full_path
+    create (@full_path + "/#{@full_name}.tex"), 'latex_letter.tex'
+    erb (@full_path + "/#{@full_name}.tex")
+    create (@full_path + "/.gitignore"), 'gitignore_latex'
+    create (@full_path + '/figures')
+    create (@full_path + "/figures/sample-letterhead.pdf"), 'sample-letterhead.pdf'
+    create (@full_path + "/figures/sample-signature.pdf"), 'sample-signature.pdf'
+  end
+end

data/default/recipes/numbers.rb

@@ -0,0 +1,6 @@
+class NumbersRecipe
+  def recipe
+    create @full_path, 'numbers.txt'
+    erb @full_path
+  end
+end

data/default/recipes/py.rb

@@ -0,0 +1,6 @@
+
+class PyRecipe
+  def recipe
+    create @full_path, 'python3_file.py'
+  end
+end

data/default/recipes/python.rb

@@ -0,0 +1,6 @@
+
+class PythonRecipe
+  def recipe
+    create @full_path, 'python_file.py'
+  end
+end

data/default/recipes/python3.rb

@@ -0,0 +1,6 @@
+
+class Python3Recipe
+  def recipe
+    create @full_path, 'python3_file.py'
+  end
+end

data/default/recipes/r.rb

@@ -0,0 +1,5 @@
+class RRecipe
+  def recipe
+    create @full_path, 'r_file.r'
+  end
+end

data/default/recipes/rb.rb

@@ -0,0 +1,5 @@
+class RbRecipe
+  def recipe
+    create @full_path, 'ruby_file.rb'
+  end
+end

data/default/recipes/ruby.rb

@@ -0,0 +1,6 @@
+
+class RubyRecipe
+  def recipe
+    create @full_path, 'ruby_file.rb'
+  end
+end

data/default/recipes/simple.rb

@@ -0,0 +1,8 @@
+
+class SimpleRecipe
+  def recipe
+    create @full_path
+    create (@full_path + "/#{@full_name}.tex"), 'latex_simple.tex'
+    create (@full_path + "/.gitignore"), 'gitignore_latex'
+  end
+end

data/default/recipes/sublime.rb

@@ -0,0 +1,6 @@
+
+class SublimeRecipe
+  def recipe
+    create (@target_dir + '/' + @full_name + '.sublime-project'), 'sublime-project'
+  end
+end

data/default/recipes/test.rb

@@ -0,0 +1,13 @@
+
+class TestRecipe
+  def recipe
+    puts "Testing"
+    puts 'Name: ' + Settings::NAME
+    puts 'Email: ' + Settings::EMAIL
+
+    puts @argv
+    #
+    invoke(Test2Recipe)
+
+  end
+end

data/default/recipes/test2.rb

@@ -0,0 +1,8 @@
+
+class Test2Recipe
+  def recipe
+    puts "Testing 2"
+    puts 'Name: ' + Settings::NAME
+    puts 'Email: ' + Settings::EMAIL
+  end
+end

data/default/recipes/tex.rb

@@ -0,0 +1,6 @@
+
+class TexRecipe
+  def recipe
+    create @full_path, 'latex_simple.tex'
+  end
+end

data/default/resources/Makefile

@@ -0,0 +1,15 @@
+CXXFLAGS =	-O2 -g -Wall -fmessage-length=0
+
+OBJS =		variable_name.o
+
+LIBS =
+
+TARGET =	variable_name
+
+$(TARGET):	$(OBJS)
+	$(CXX) -o $(TARGET) $(OBJS) $(LIBS)
+
+all:	$(TARGET)
+
+clean:
+	rm -f $(OBJS) $(TARGET)

data/default/resources/cpp_file.cpp

@@ -0,0 +1,16 @@
+//============================================================================
+// Name        : HelloWorldMake.cpp
+// Author      : 
+// Version     :
+// Copyright   : Your copyright notice
+// Description : Hello World in C, Ansi-style
+//============================================================================
+
+#include <stdio.h>
+#include <stdlib.h>
+
+int main(void)
+{
+  puts("Hello World!!!!!!");
+  return EXIT_SUCCESS;
+}

data/default/resources/default

@@ -0,0 +1 @@
+This is a default template.

data/default/resources/gitignore_basic

@@ -0,0 +1,23 @@
+
+*.log
+*.7z
+*.dmg
+*.gz
+*.iso
+*.jar
+*.rar
+*.tar
+*.zip
+*.sql
+*.sqlite
+*.com
+*.class
+*.dll
+*.exe 
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db

data/default/resources/gitignore_latex

@@ -0,0 +1,35 @@
+
+*.log
+*.7z
+*.dmg
+*.gz
+*.iso
+*.jar
+*.rar
+*.tar
+*.zip
+*.sql
+*.sqlite
+*.com
+*.class
+*.dll
+*.exe
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+*.aux
+*.bbl
+*.bcf
+*.blg
+*.fdb_latexmk
+*.synctex.gz
+*.out
+*.snm
+*.toc
+*.run.xml
+*.na