Neurogami-rhesus 0.2.5 → 0.3.1

data/README.md

@@ -24,7 +24,6 @@ The results are copied out to some dir realtive to where you invoked the 'rhesus
 FEATURES/PROBLEMS
 -----------------
 
-
 Generates files for you to jump-start projects that have common code.
 
 Makes asorted assumptions and needs more testing with a variety of template sources
@@ -45,11 +44,12 @@ Run `rhesus list` to see the available templates
 
    $ rhesus list
 
+NOTE: This behavior might vanish, since in actual use it is actually useless. See below.
+
 
 Run `rhesus gen` to generate code from a template.  You may optionally pass the name
 of a template, but if you leave that out you'll get a list to pick from.
 
-
     $ rhesus gen
     1: jimpanzee.about
     2: jimpanzee.basic
@@ -57,6 +57,16 @@ of a template, but if you leave that out you'll get a list to pick from.
 
     Enter the number of the template to use: 
 
+If you pass a complete template name then that is automatically  used:
+
+    $ rhesus gen  jimpanzee.midi
+
+Run `rhesus stuff` to have rhesus show a list of templates that match on `stuff`.
+
+    $ rhesus midi
+    1: jimpanzee.midi
+
+    Enter the number of the template to use: 
 
 
 The code assumes you have a directory `.rhesus` in your home directory (+~/.rhesus+)
@@ -194,6 +204,10 @@ A value of `FooBar`, for example,  would create `src/foo_bar/foo_bar.rb`. But th
 
 
 
+Note:  Some of the code for auto-mangling file and path names is changing.  Initially the code was specific to Ruby apps, but it's really very handy for all sorts of things, such as Haskell projects.
+
+But these other things have different conventions; code to apply appropriate conventions is being added.
+
 
 REQUIREMENTS
 -------------

data/Rakefile

@@ -26,7 +26,6 @@ PROJ.version = Neurogami::Rhesus::VERSION
 PROJ.readme_file = 'README.md'
 PROJ.summary = "Really simple, practical code generator."
 
-# PROJ.spec.opts << '--color'
 
 desc "Bacon specs"
 task 'test:bacon' do
@@ -36,4 +35,111 @@ end
 
 desc 'test'
 task :test => 'test:bacon'
+
+namespace :issues do
+  desc 'Open issues'
+  task :open do
+    paged_issues ENV['GH_NO_CACHE']
+  end
+
+  desc 'Create a new issue'
+  task :create do
+    issue_details = ENV['DETAILS'].to_s.strip
+    if issue_details.empty?
+      warn "No issue details!"
+    else
+      title, body =  issue_details.split(' -- ', 2)
+      create_issue  title, body 
+    end
+  end
+end
+
+
+def create_issue title, body
+  require 'net/http'
+  require 'uri'
+
+
+  token = ENV['GH_AUTH_TOKEN']
+  url = 'http://github.com/api/v2/yaml/issues/open/Neurogami/rhesus'
+  res = Net::HTTP.post_form(URI.parse(url),
+                            {'title'=> title, 
+                                'body' => body,
+                                'login' => 'Neurogami',
+                                 'token'=> token }
+                           )
+                           warn res.body
+
+end
+
+def ___
+  warn "\n" + '_' * 30
+end
+
+def paged_issues no_cache = false
+  ARGV.clear 
+  warn "Hit enter after each issue to see the next one"
+  issues(no_cache).each do |issue|
+    ___    
+    warn "Title: #{issue['title']}"
+    warn "Details: \n#{issue['body']}"
+    ___
+    gets
+  end
+  warn "\nThat's it!"
+end
+
+
+def issues no_cache = false
+  issues_cache = 'issues.yaml'
+  if no_cache || !File.exist?(issues_cache)
+    warn "Reloading issues from GitHub ..."
+    File.open( issues_cache, 'w'){ |f| f.puts get_issues }
+  end
+  YAML.load(IO.read(issues_cache))['issues']
+end
+
+def get_issues
+  #require 'yaml'
+  #   url = 'http://github.com/api/v2/yaml/issues/list/Neurogami/rhesus/open'  
+  # open(url).read  
+
+  %~--- 
+issues: 
+- user: Neurogami
+  updated_at: 2009-08-25 11:15:11 -07:00
+  body: "The  app started out to handle Ruby code, but is handy for almost anything (such as layout out a Haskel project).  But not all languages use the same CamelCase and snake_case conventions.  \r\n\
+    \r\n\
+    When the code is inventing file names it needs to follow appropriate language conventions. "
+  title: All variable-driven file names are snake_cased by default
+  number: 1
+  votes: 0
+  closed_at: 
+  labels: 
+  - configuration
+  created_at: 2009-08-25 10:09:44 -07:00
+  state: open
+- user: Neurogami
+  updated_at: 2009-08-25 10:16:28 -07:00
+  body: |-
+    Running 
+    
+         rhesus list
+    
+    or 
+    
+        rhesus gen
+    
+    gives a full list of available templates, which can get too big to be useful.
+  title: CLI UI won't scale
+  number: 2
+  votes: 0
+  closed_at: 
+  labels: 
+  - UI
+  created_at: 2009-08-25 10:13:53 -07:00
+  state: open
+  ~
+end
+
 # EOF

data/bin/rhesus

@@ -26,7 +26,7 @@ def help(message = nil)
 end
 
 def process_template template_name
-  puts "Using template #{template_name}"
+  puts " - Using template #{template_name.inspect}"
 
   var_set = {}
 
@@ -92,20 +92,33 @@ def copy_over_default_templates
   FileUtils.cp_r File.dirname(__FILE__) + "/../default-templates/.", Neurogami::Rhesus::Core.user_template_directory
 end
 
-def generate_from_template
+def generate_from_template filter = /.*/
+  
+  filter = Regexp.new(filter) unless filter.is_a?(Regexp)
+
   if ARGV.first
-    puts "Generate from #{ARGV.first} template"
+    ARGV.first.strip!
+    t = Neurogami::Rhesus::Core.templates.find{ |t| t == ARGV.first }  
+    ARGV.clear
+    process_template  t
   else
-    Neurogami::Rhesus::Core.templates.each_with_index do |template, idx|
+    templates = {}
+    Neurogami::Rhesus::Core.templates.select{ |t| t =~ filter }.each_with_index do |template, idx|
+      templates[idx+1] = template
       puts "#{idx+1}: #{template}"
     end
-    item =  0
-    while item < 1 || item-1 > Neurogami::Rhesus::Core.templates.size
-      print "Enter the number of the template to use: "
-      item = gets.to_i
+    if templates.empty?
+      warn "No templates matched on #{filter.pretty_inspect.strip}."
+    else
+      item =  0
+      while item < 1 || item-1 > Neurogami::Rhesus::Core.templates.size
+        print "Enter the number of the template to use: "
+        item = gets.to_i
+      end
+
+      process_template templates[item] # Neurogami::Rhesus::Core.templates[item-1]
     end
 
-    process_template Neurogami::Rhesus::Core.templates[item-1]
   end
 end
 #-------------------------------------------------
@@ -127,7 +140,9 @@ else
   when '--setup'
     setup
   else
-    puts "Nothing known about #{ARGV[0]}"
+    #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
+    generate_from_template option.strip
   end
 end
 

data/lib/rhesus/core.rb

@@ -19,10 +19,6 @@ module Neurogami
   module Rhesus
 
     class Core
-      # 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}
-      @@re = haz_vars.map { |x|   x + '$' }.join( '|') 
-      @@re = Regexp.new "(#{@@re})$"
 
       # http://refactormycode.com/codes/281-given-a-hash-of-variables-render-an-erb-template
       @@m = Module.new do
@@ -45,40 +41,40 @@ module Neurogami
         end
       end
 
-      def self.process_template f, variables_hash
+      def self.process_template template_text, variables_hash
         create_methods_from_hash variables_hash
-        t = ERB.new(IO.read(f), 0, "%<>")
+        t = ERB.new(template_text, 0, "%<>")
         t.result @@m.binding
       end
 
       def self.projects
         get_projects_directories.map { |path|
           path.sub! user_template_directory + '/', ''
-          #path.identifier_to_path!
           path
         }
       end
 
-
-
       def self.tuple_base_name_pair name
         [snake_case(name), camelize(name)]
       end
 
 
+      #  
       def self.required_vars_for_template_set template_name
         #template_name.identifier_to_path!
-        vars = {}
+        vars = []
 
         selected_template_files(template_name).map do |path|
           next unless File.file? path
           next unless path =~ @@re
-
-          required_vars(path).each do |v|
-            vars[v] = v
-          end
+          file_lines = IO.readlines path
+          vars.concat(required_vars(file_lines))
+          #file_lines.each do |v|
+          #  vars[v] = v
+          #end
         end
-        vars.keys.sort
+        vars.uniq!
+        vars.sort
       end
 
       def self.templates
@@ -89,18 +85,15 @@ module Neurogami
         end
       end
 
-      def self.required_vars f
-        vars = {}
-        IO.readlines(f).each do |l|
-          l =~ /(<%=)\s*(\S+)\s*(%>)/
-          if $&
-            varname = $2
-            varname.strip!
-            varname = varname.split('.').first
-            vars[varname] = varname
-          end
+      def self.required_vars file_lines
+        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
         end
-        vars.keys
+        vars.uniq
       end
 
 
@@ -116,13 +109,12 @@ module Neurogami
       end
 
       def self.selected_template_files template_name
-        # template_name.identifier_to_path!
-        Dir.glob user_template_directory + '/' + template_name + '/**/*'
+        Dir.glob( user_template_directory + '/' + template_name + '/**/*', File::FNM_DOTMATCH).select { |f| f !~ /\.$/ }
       end
 
-      def self.add_user_haz_vars
-        if File.exist?(File.expand_path( '~/.rhesus/haz_vars.txt'))
-          IO.readlines(File.expand_path( '~/.rhesus/haz_vars.txt')).each { |x| haz_vars  << x.strip  unless x.strip.empty? }
+      def self.add_user_haz_vars haz_vars
+        if File.exist?(File.expand_path( user_template_directory + '/haz_vars.txt'))
+          IO.readlines(File.expand_path( user_template_directory + '/haz_vars.txt')).each { |x| haz_vars  << x.strip  unless x.strip.empty? }
         end
       end
 
@@ -134,11 +126,36 @@ module Neurogami
         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
+          end
+          path.gsub( template_var, given_value )
+      end
+
+      # How can this be tested?  This method is more or less the core of the
+      # tool (other key method: extracting the set of vars from the templates)
+      # The trouble is that the code works by creating a side effect; the return
+      # value is nothing.
+      #
+      # This method does multiple things: computes file paths;
+      # alters file path  basedon variable values;  calls
+      # out to read in file text, alter it with variable subsition, and
+      # write it out; do direct file copies.
+
       def self.process template_name, var_set, location, path
         relative_path  = path.sub user_template_directory , ''
         short_path = path.sub user_template_directory, ''
         real_path = short_path.sub(template_name + '/', '')
-        var_set.each { |k,v| real_path.gsub!( k, v.to_snake_case ) }
+
+        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
@@ -146,7 +163,8 @@ module Neurogami
         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
-          text = process_template path, var_set 
+          source_text = IO.read path
+          text = process_template source_text, var_set 
           File.open(file_to_write_to, "w"){|f| f.puts text }
         else
           FileUtils.cp path, file_to_write_to
@@ -159,6 +177,13 @@ module Neurogami
         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 
+      @@re = haz_vars.map { |x|   x + '$' }.join( '|') 
+      @@re = Regexp.new "(#{@@re})$"
+
     end
   end
 end

data/lib/rhesus/utils.rb

@@ -9,15 +9,15 @@ def template_base_dir
   File.expand_path( File.join( File.dirname(__FILE__), '..', 'templates' ) )
 end
 
-def copy_over_prebuilt_template base_path, name
-  %w{model view controller ui}.each do |unit|
-    FileUtils.mkdir_p File.join(base_path, name)
-    from = File.join( template_base_dir, name , name + '_' + unit + '.rb')
-    dest = File.join(base_path, name, name + '_' + unit + '.rb' )
-    warn "cp '#{from}' to '#{dest}'"
-    FileUtils.cp from, dest 
-  end
-end
+#def copy_over_prebuilt_template base_path, name
+#  %w{model view controller ui}.each do |unit|
+#    FileUtils.mkdir_p File.join(base_path, name)
+#    from = File.join( template_base_dir, name , name + '_' + unit + '.rb')
+#    dest = File.join(base_path, name, name + '_' + unit + '.rb' )
+#    warn "cp '#{from}' to '#{dest}'"
+#    FileUtils.cp from, dest 
+#  end
+#end
 
 def setup_directory path
   FileUtils.mkdir_p path.gsub("\\", "/")

data/lib/version.rb

@@ -1,11 +1,7 @@
 module Neurogami
   module Rhesus
     # :stopdoc:
-    VERSION = '0.2.5'
-    # :startdoc:
-
-    # Returns the version string for the library.
-    #
+    VERSION = '0.3.1'
 
     def self.version
       VERSION

data/test/test_rhesus.rb

@@ -2,22 +2,24 @@ require 'rubygems'
 require 'bacon'
 require 'lib/rhesus/core'
 
+$here = File.expand_path(File.dirname(__FILE__))
+
 describe 'A rhesus directory' do
 
   before do
+
     @nrc = Neurogami::Rhesus::Core
     class Neurogami::Rhesus::Core
-      #def self.user_template_directory
-      #   "~/.rhesus"
-      #end
-
+      def self.user_template_directory
+         "#{$here}/.rhesus"
+      end
     end
 
   end
 
-
+  # Not all that useful ....
   it 'should be in the home directory' do
-    @nrc.user_template_directory.should.equal '/home/james/.rhesus'
+    @nrc.user_template_directory.should.equal $here  + '/.rhesus'
   end
 
   it 'should exist' do
@@ -32,20 +34,25 @@ describe 'A rhesus directory' do
     @nrc.templates.size.should.equal 5
   end
 
+end
+
+describe 'The core Rhesus code' do
 
-  #it 'should have 4 files in the monkeybars:about template set' do
-  #end
+  it 'really needs to populate an Erb string with key/value pairs' do
+    template_text = "I've got <%= adj1 %>, \nand I'm <%= adj2 %> <%= adj3 %>"
+    variable_set = { :adj1 => 'soul' , :adj2 => 'super', :adj3 => 'bad' }
+    new_text = Neurogami::Rhesus::Core.process_template template_text, variable_set 
+    new_text.should ==   "I've got soul, \nand I'm super bad"
+  end
 
-  #it 'returns a project template reference given the qualified name "monkeybars:about"' do
-  #  pt = @nrc.get "monkeybars:about"
-  #  pt.class.should.equal Neurogami::Rhesus::TemplateSet 
-  #end
+  it 'dang well better extract variable names from Erb, bro' do
+    template_text = "I've got <%= adj1 %>, \nand I'm <%= adj2 %> <%= adj3 %>. And I mean <%= adj2 %> <%= adj3 %>"
 
-end
+    vars = Neurogami::Rhesus::Core.required_vars template_text.split( "\n")
+    vars.sort!
+    vars.should  == ['adj1', 'adj2', 'adj3' ]
 
-__END__
+  end
 
-What are the key useful things we might want?
+end
 
-* List available templates
-* Use one of those templates

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: Neurogami-rhesus
 version: !ruby/object:Gem::Version 
-  version: 0.2.5
+  version: 0.3.1
 platform: ruby
 authors: 
 - James Britt / Neurogami
@@ -56,7 +56,6 @@ files:
 - test/test_rhesus.rb
 has_rdoc: false
 homepage: http://www.neurogami.com/code
-licenses: 
 post_install_message: 
 rdoc_options: 
 - --main
@@ -80,7 +79,7 @@ requirements: []
 rubyforge_project: !binary |
   AA==
 
-rubygems_version: 1.3.5
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 3
 summary: Really simple, practical code generator.