Neurogami-rhesus 0.3.1 → 0.3.3

data/Manifest.txt

@@ -1,6 +1,8 @@
 lib/rhesus.rb
 lib/rhesus/core.rb
 lib/rhesus/utils.rb
+lib/rhesus/common.rb
+lib/rhesus/rhezamar.rb
 lib/templates/splash_screen
 lib/templates/basic/basic_view.rb
 lib/templates/basic/basic_ui.rb

data/README.md

@@ -127,6 +127,28 @@ Rhesus starts with some assumptions about what files might be using Erb.  You ca
 
 By default, the file-end patterns are: `rb txt rhtml ini yml yaml Rakefile gemspec`.
 
+
+NOTE: A recent addition, and still evolving, is the use of a `.options.yaml` file in the root of a template folder.
+
+The problem is that you may have a large set files that do not need any template processing.  
+
+Worse, some files may be actual templates (or contain Erb markup) that should be copied over as-is, but would otherwise get preprocessed.
+
+a `.options.yaml` file can contain a hash of file patterns, like this
+
+
+        noparse: 
+          -  /gems/gems/rack 
+          - .git/
+
+        ignore:
+          - .git/
+
+This tells `rhesus` that any file whose template path matches on any of the items listed un `noparse` should not be parsed for tempalte variables, and simply copied over as-is.
+
+The array under `ignore` means to ignore any files or directories that match on that substring. No parsing, no copying.
+
+
 When you select a template set, Rhesus scans these files for Erb variables.  It then prompts
 you to provide values.  If you use any of these variable names in file or path names then Rhesus
 will apply those values to the names and paths when applying the template.  
@@ -138,6 +160,7 @@ will have the same value used in both.
 If a file in a template set is not among the file types that may have Erb  (e.g., jar, dll, gif)
 then it will be copied over as-is.
 
+     
 
 For example:
 
@@ -209,6 +232,17 @@ Note:  Some of the code for auto-mangling file and path names is changing.  Init
 But these other things have different conventions; code to apply appropriate conventions is being added.
 
 
+NOTE: Another recent evolving features is the use of "rhamaze" templating.   
+
+Suppose you have a Ramaze project template set, with some `.xhtml` files that contain Erb markup.  You do not want Rhesus to preprocess this as Erb, but you *do* want to have some interpolated variables.
+
+So, you need to add a leading line that contains the string `RHEMAZAR` and do your rhesus variables using this syntax:
+
+     <|= my_variable |>
+
+That leading line will be skipped when processing the file.
+
+
 REQUIREMENTS
 -------------
 

data/Rakefile

@@ -23,8 +23,9 @@ PROJ.authors = 'James Britt / Neurogami'
 PROJ.email = 'james@neurogami.com'
 PROJ.url = 'http://code.neurogami.com'
 PROJ.version = Neurogami::Rhesus::VERSION
-PROJ.readme_file = 'README.md'
 PROJ.summary = "Really simple, practical code generator."
+PROJ.readme_file = 'README.md'
+
 
 
 desc "Bacon specs"

data/bin/rhesus

@@ -29,6 +29,7 @@ def process_template template_name
   puts " - Using template #{template_name.inspect}"
 
   var_set = {}
+  Neurogami::Rhesus::Core.load_options  template_name
 
   Neurogami::Rhesus::Core.required_vars_for_template_set(template_name).each do |var|
     print "Value for #{var}: "
@@ -121,7 +122,9 @@ def generate_from_template filter = /.*/
 
   end
 end
+
 #-------------------------------------------------
+
 if ARGV.empty?
   help
 else
@@ -139,6 +142,9 @@ else
 
   when '--setup'
     setup
+
+  when '--install' || '-i'
+     install_template_from_repo
   else
     #puts "Nothing known about #{ARGV[0]}"
     # Treat the same as gen, but use the argument as a pattern filter to reduce the number of items show

data/lib/rhesus/common.rb

@@ -0,0 +1,27 @@
+module Neurogami
+  module Rhesus
+
+    module Common
+
+      module ClassMethods
+
+        def user_dir_exists?
+          File.exists? user_template_directory
+        end
+
+        def user_template_directory
+          File.expand_path "~/.rhesus"
+        end
+      end
+
+
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+    end
+
+
+  end
+end

data/lib/rhesus/core.rb

@@ -1,6 +1,7 @@
 require 'pp'
 require 'erb'
 
+
 class String
   def to_snake_case
     snake_case self
@@ -20,6 +21,14 @@ module Neurogami
 
     class Core
 
+      include Neurogami::Rhesus::Common
+
+
+      ERB_RE = {
+        :ruby_erb => /(<%=)\s*(\S+)\s*(%>)/,
+        :rhemazar => /(<\|=\s*)(\S+)(\s*\|>)/
+
+      }
       # http://refactormycode.com/codes/281-given-a-hash-of-variables-render-an-erb-template
       @@m = Module.new do
         class << self
@@ -41,10 +50,27 @@ module Neurogami
         end
       end
 
-      def self.process_template template_text, variables_hash
+      # Can something be added so that if this is actual Erb content it
+      # is processed using not-Erb? 
+      def self.process_template template_text, variables_hash, erb  = :ruby_erb
+        if variables_hash.empty?
+          return template_text
+        end
+
+        # :rhemazar : :ruby_erb
         create_methods_from_hash variables_hash
-        t = ERB.new(template_text, 0, "%<>")
-        t.result @@m.binding
+        case erb
+        when :eruby_erb
+          t = ERB.new(template_text, 0, "%<>")
+          t.result @@m.binding
+        when :rhemazar 
+          t = Neurogami::Rhesus::Rhezamar.new template_text
+          t.result variables_hash
+        else
+          t = ERB.new(template_text, 0, "%<>")
+          t.result @@m.binding
+        end
+
       end
 
       def self.projects
@@ -59,19 +85,48 @@ module Neurogami
       end
 
 
+      # Trouble: Suppose your template set includes a file, index.xhtml, and 
+      # that file is meant to be an Erb template.  The <%= foo %> stuff inside
+      # is exactly what should be copied over; it should *not* be preprocessed.
+      #
+      # How can Rhesus be told to not preprocess some file? It's tricky, if you want,
+      # for example, to have a file that has Rhesus-substitution AND do-not-touch Erb. 
+      # One option could be to have certain file types use a different Rhesus-magic
+      # variable syntax:
+      #
+      #     <?r=   ?>  in place of <%= %>
       #  
+      # Perhaps files that need special treatment can have some magic comment up top?
+      # Too fugly?
+      #
+      # Thu Sep 10 23:01:43 MST 2009
+      #   Using a modifued version of Ezamar engine.
+      # Still need a nice way to indicate when this is to be used;
+      # current approach has RHEMAZAR in the first line of the file, which
+      # should get striped
       def self.required_vars_for_template_set template_name
-        #template_name.identifier_to_path!
+
         vars = []
 
         selected_template_files(template_name).map do |path|
           next unless File.file? path
           next unless path =~ @@re
+          next if  ignore(path, @@options['ignore'])
+
+          next if path =~ /\.git$/
+          load_options template_name
+          next  if no_parse( path, @@options['noparse']   ) 
+          next if  ignore(path, @@options['ignore'])
+
           file_lines = IO.readlines path
-          vars.concat(required_vars(file_lines))
-          #file_lines.each do |v|
-          #  vars[v] = v
-          #end
+          top_line = file_lines.first
+
+          erb = :ruby_erb 
+          if top_line =~ /RHEMAZAR/  
+            file_lines.shift
+            erb = :rhemazar
+          end
+          vars.concat required_vars(file_lines, erb)
         end
         vars.uniq!
         vars.sort
@@ -85,13 +140,21 @@ module Neurogami
         end
       end
 
-      def self.required_vars file_lines
+      def self.required_vars file_lines, erb_style = :ruby_erb
+
+        if erb_style == :rhemazar
+        end
         vars = []
         file_lines.each do |l|
-          vars.concat l.scan(/(<%=)\s*(\S+)\s*(%>)/).map{ |m| m[1].strip.split('.').first}
-          #variables.each do |v|
-          #  vars[v] = v
-          #end
+          # XXX
+          re = ERB_RE[erb_style]
+          _v = l.scan( ERB_RE[erb_style] ).map do |m| 
+            m[1].strip.split('.').first
+          end
+
+          unless _v.to_s.strip.empty?
+            vars.concat  _v
+          end
         end
         vars.uniq
       end
@@ -118,25 +181,18 @@ module Neurogami
         end
       end
 
-      def self.user_dir_exists?
-        File.exists? user_template_directory
-      end
-
-      def self.user_template_directory
-        File.expand_path "~/.rhesus"
-      end
 
       def self.language_appropriate_renaming path, template_var, given_value
         # Hack to see what might work:
         renaming_map = {
           /\.rb$/ => :to_snake_case
         }
-          renaming_map.each do |file_pattern, renaming_method|
-            if path =~ file_pattern
-              return path.gsub( template_var, given_value.send(renaming_method) )
-            end
+        renaming_map.each do |file_pattern, renaming_method|
+          if path =~ file_pattern
+            return path.gsub( template_var, given_value.send(renaming_method) )
           end
-          path.gsub( template_var, given_value )
+        end
+        path.gsub( template_var, given_value )
       end
 
       # How can this be tested?  This method is more or less the core of the
@@ -154,30 +210,87 @@ module Neurogami
         short_path = path.sub user_template_directory, ''
         real_path = short_path.sub(template_name + '/', '')
 
+        return if ignore(path, @@options['ignore'])
+
         var_set.each { |key, value| real_path = language_appropriate_renaming( real_path, key, value ) }
-        
+
         write_to = location + real_path 
         destination_dir = File.expand_path(File.dirname(write_to))
         FileUtils.mkdir_p destination_dir
         file_to_write_to  = File.expand_path write_to
         rename( file_to_write_to ) if File.exist? file_to_write_to 
+
+
         # Do a straight file copy unless this file might be using Erb
-        if path =~ @@re
-          source_text = IO.read path
-          text = process_template source_text, var_set 
+
+        if path =~ @@re && !no_parse( path, @@options['noparse']   )
+
+          source_text = IO.readlines path
+          # A shame we read each file twice FIXME
+          top_line = source_text.first
+
+          erb = :ruby_erb 
+          if top_line =~ /RHEMAZAR/  
+            erb = :rhemazar
+            source_text.shift
+          end
+
+          text = process_template source_text.join, var_set, erb
+          warn "Create #{file_to_write_to}"
+
           File.open(file_to_write_to, "w"){|f| f.puts text }
         else
+          warn "Copy #{path} to #{file_to_write_to}"
           FileUtils.cp path, file_to_write_to
         end
       end
 
 
+      def self.ignore path, ignore_filters 
+        return false if ignore_filters.nil?  || ignore_filters.empty?
+        ignore_filters.each do |patt|
+          return true if path =~ patt
+        end
+        false
+      end
+      def self.no_parse path,  no_parse_filters = []
+        return false if no_parse_filters.nil? or no_parse_filters.empty?
+        no_parse_filters.each do |patt|
+          return true if path =~ patt
+        end
+        false
+      end
+
+      def self.load_options template_name
+        full_path = user_template_directory + '/' + template_name 
+
+        @@options ||= if File.exist? full_path+ '/.options.yaml'
+                        o = YAML.load(IO.read( full_path + '/.options.yaml'))
+          o['noparse'] ||= []
+          o['noparse'].map!{ |patt| Regexp.new(Regexp.escape(patt)) }
+          o['ignore'] ||= []
+          o['ignore'] << '.options.yaml'
+          o['ignore'].map!{ |patt| Regexp.new(Regexp.escape(patt)) }
+          o
+                      else
+                        {}
+                      end
+
+
+      end
+
+
       def self.rename full_file_path
         ts = Time.now.to_i.to_s
         FileUtils.mv full_file_path, full_file_path + '.' + ts 
       end
 
 
+
+
+
+
+
       # Hacky :( FIXME Add a better way to define what files get slurped for parsing
       haz_vars = %w{ rb txt rhtml ini yml yaml Rakefile rake gemspec feature}
       add_user_haz_vars haz_vars 
@@ -185,5 +298,7 @@ module Neurogami
       @@re = Regexp.new "(#{@@re})$"
 
     end
+
+
   end
 end

data/lib/rhesus/installer.rb

@@ -0,0 +1,35 @@
+
+module Neurogami
+  module Rhesus
+
+    class InstallationError < Exception
+    end
+
+    class Installer
+
+      
+     include Neurogami::Rhesus::Common
+
+      class << self
+
+
+        def install_from_repo repo_url
+          raise InstallationError.new("No ~/.rhesus folder") unless user_dir_exists?
+          begin 
+          Dir.chdir(user_template_directory) do
+           git_repo_clone repo_url
+         end
+          rescue Exception
+              raise InstallationError.new("Error cloning repo: #{$!}")
+          end
+        end
+
+
+        def git_repo_clone repo_url
+          warn  `git clone #{repo_url}`
+        end
+
+      end
+    end
+  end
+end

data/lib/rhesus/rhezamar.rb

@@ -0,0 +1,18 @@
+module Neurogami
+  module Rhesus
+    class Rhezamar
+
+      def initialize text
+        @text = text
+      end
+
+      def result variables_hash
+        t = @text.dup
+        variables_hash.each do |k, v|
+          t.gsub!(  /<\|=\s*#{k}\s*\|>/m, v  )
+        end
+        t
+      end
+    end
+  end
+end

data/lib/version.rb

@@ -1,7 +1,7 @@
 module Neurogami
   module Rhesus
     # :stopdoc:
-    VERSION = '0.3.1'
+    VERSION = '0.3.3'
 
     def self.version
       VERSION

data/test/test_rhesus.rb

@@ -1,6 +1,17 @@
 require 'rubygems'
 require 'bacon'
-require 'lib/rhesus/core'
+
+h = File.expand_path(File.dirname(__FILE__))
+$:.unshift h + '/../lib/'
+
+require 'rhesus'
+
+#require 'lib/rhesus/core'
+#require 'lib/rhesus/installer'
+
+
+require 'mockfs'
+
 
 $here = File.expand_path(File.dirname(__FILE__))
 
@@ -54,5 +65,54 @@ describe 'The core Rhesus code' do
 
   end
 
+  
+  it 'needs to know when a file with Erb is not meant to be interpolated' do
+
+    template_text = "Hey! \n<|= zoobar |> got <%= _adj1 %>, \nand I'm <%= _adj2 %> <%= _adj3 %>. And <|= goober |> mean <%= _adj2 %> <%= _adj3 %>"
+
+    vars = Neurogami::Rhesus::Core.required_vars( template_text.split( "\n"), :rhemazar )
+    vars.sort!
+    vars.should  == ['goober', 'zoobar' ]
+
+  end
+
+
+   
+  it 'needs to handle rhezamar templating' do
+
+    variables_hash =  {'zoobar' => 'Jimbo', 'goober' => 'Goober' }
+    template_text = "<|= zoobar |> got <%= _adj1 %>, \nand I'm <%= _adj2 %> <%= _adj3 %>. And <|= goober |> mean <%= _adj2 %> <%= _adj3 %>"
+    expected = "Jimbo got <%= _adj1 %>, \nand I'm <%= _adj2 %> <%= _adj3 %>. And Goober mean <%= _adj2 %> <%= _adj3 %>"
+    t = Neurogami::Rhesus::Rhezamar.new template_text
+    results = t.result variables_hash
+    results.should.equal expected
+
+    
+  end
 end
 
+describe 'The Rhesus installer' do
+  MockFS.mock = true
+
+  it 'would be super-duper if it handled a git repo URL as a means to install a new template' do
+    repo_url =  'git://github.com/Neurogami/gae.ramaze.git'
+
+    lambda { Neurogami::Rhesus::Installer.install_from_repo repo_url }.should.not.raise(Neurogami::Rhesus::InstallationError)
+
+
+  end
+
+
+#  it 'knows when a repo URL is valid' do
+#    repo_url =  'git@github.com:Neurogami/andi.git'
+#    Neurogami::Rhesus::Installer.is_valid_repo_url?(repo_url).should.equal true
+
+#  end
+
+#  it 'can pull out repo URL parts' do
+
+#   end
+
+  MockFS.mock = false
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: Neurogami-rhesus
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
+  version: 0.3.3
 platform: ruby
 authors: 
 - James Britt / Neurogami
@@ -41,6 +41,9 @@ files:
 - lib/rhesus.rb
 - lib/rhesus/core.rb
 - lib/rhesus/utils.rb
+- lib/rhesus/installer.rb
+- lib/rhesus/common.rb
+- lib/rhesus/rhezamar.rb
 - lib/templates/about/about_controller.rb
 - lib/templates/about/about_model.rb
 - lib/templates/about/about_ui.rb