meta_code_commenter 0.0.0

data/.gitignore

@@ -0,0 +1,5 @@
+doc
+pkg
+coverage
+tags
+*.gemspec

data/.watchr

@@ -0,0 +1,21 @@
+
+def run(*args)
+  system "ruby -rubygems -Ilib:test #{args.join(' ')}"
+end
+
+def run_tests
+  system "rake test"
+end
+
+def underscore(file)
+  file.gsub('/', '_')
+end
+
+watch('test/test_.*\.rb')  {|md| run md[0] }
+watch('lib/(.*)\.rb')      { run_tests }
+watch('test/helper.rb')    { run_tests }
+
+run_tests
+
+Signal.trap("QUIT") { abort("\n") }
+Signal.trap("INT") { run_tests }

data/README.rdoc

@@ -0,0 +1,62 @@
+= Meta code commenter (mcc)
+
+Comments your meta code.
+
+== Usage
+
+  require 'mcc'
+
+  params = ARGV.inject({}) do |hash, arg|
+    key, value = arg.split(/=/)
+    hash[key] = value
+    hash
+  end
+
+  puts MetaCodeCommenter.comment(STDIN.readlines)
+
+=== Command line
+
+  $ mcc key1=value key2=value < my_meta_code
+
+=== Example
+
+  $ cat code 
+  def #{name}(proc=nil, &blk)              
+    proc ||= blk                           
+    @#{name} = Proc.new do |ptr,data,len|  
+      if data                              
+        proc.call(data.get_string(0, len)) 
+      else                                 
+        proc.call                          
+      end                                  
+      @abort ? 1 : 0                       
+    end                                    
+    @parser[:#{name}] = @#{name}           
+  end                                      
+
+  $ mcc name=on_headers < code 
+  def #{name}(proc=nil, &blk)                 # def name(proc=nil, &blk)              
+    proc ||= blk                              #   proc ||= blk                           
+    @#{name} = Proc.new do |ptr,data,len|     #   @name = Proc.new do |ptr,data,len|  
+      if data                                 #     if data                              
+        proc.call(data.get_string(0, len))    #       proc.call(data.get_string(0, len)) 
+      else                                    #     else                                 
+        proc.call                             #       proc.call                          
+      end                                     #     end                                  
+      @abort ? 1 : 0                          #     @abort ? 1 : 0                       
+    end                                       #   end                                    
+    @parser[:#{name}] = @#{name}              #   @parser[:name] = @name           
+  end                                         # end                                      
+
+== Installation (not yet)
+
+  gem install meta_code_commenter
+
+== Authors
+
+* Peter Suschlik
+
+== TODO
+
+* Fix failing test (double quotes don't work yet)
+* Use thor or something or mcc

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "meta_code_commenter"
+    gem.summary = 'Comments your meta code'
+    gem.email = "peter-mcc@suschlik.de"
+    gem.homepage = "http://github.com/splattael/meta_code_commenter"
+    gem.authors = ["Peter Suschlik"]
+
+    gem.has_rdoc = true
+    gem.extra_rdoc_files = [ "README.rdoc" ]
+
+    gem.add_development_dependency "riot"
+    gem.add_development_dependency "riot_notifier"
+
+    gem.test_files = Dir.glob('test/test_*.rb')
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+# Test
+require 'rake/testtask'
+desc 'Default: run unit tests.'
+task :default => :test
+task :test => :check_dependencies
+
+Rake::TestTask.new(:test) do |test|
+  test.test_files = FileList.new('test/test_*.rb')
+  test.libs << 'test'
+  test.verbose = true
+end
+
+# RDoc
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rd|
+  rd.title = "Riot Notifier"
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include("README.rdoc", "lib/*.rb")
+  rd.rdoc_dir = "doc"
+end
+
+
+# Misc
+desc "Tag files for vim"
+task :ctags do
+  dirs = $LOAD_PATH.select {|path| File.directory?(path) }
+  system "ctags -R #{dirs.join(" ")}"
+end
+
+desc "Find whitespace at line ends"
+task :eol do
+  system "grep -nrE ' +$' *"
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/bin/mcc

@@ -0,0 +1,9 @@
+require 'mcc'
+
+params = ARGV.inject({}) do |hash, arg|
+  key, value = arg.split(/=/)
+  hash[key] = value
+  hash
+end
+
+puts MetaCodeCommenter.comment(STDIN.readlines)

data/lib/mcc.rb

@@ -0,0 +1 @@
+require 'meta_code_commenter'

data/lib/meta_code_commenter.rb

@@ -0,0 +1,59 @@
+
+module MetaCodeCommenter
+
+  def self.comment(lines, params={})
+    lines = lines.split(/\n/) if lines.respond_to?(:to_str)
+    Generator.new(lines, params).to_s
+  end
+
+  class Evaluator
+    instance_methods.each {|m| undef_method m unless m =~ /^__/ }
+
+    def initialize(vars)
+      vars.each do |key, value|
+        eval <<-RUBY
+          def #{key}
+            #{value.inspect}
+          end
+        RUBY
+      end
+    end
+
+    def __eval__(line)
+      eval(%{"#{line}"})
+    end
+
+    def method_missing(method, *args, &block)
+      method.to_s
+    end
+  end
+
+  class Generator
+    include Enumerable
+
+    def initialize(lines, params={})
+      @lines = lines.map(&:chomp)
+      @evaluator = Evaluator.new(params)
+      @max_length = (lines.max_by(&:length) || "").length
+      @max_length += 1 unless @max_length % 2 != 0
+      @remove_spaces = @lines.map { |line| (line[/^\s+/] || "").length }.min
+    end
+    
+    def generate(line)
+      pad = " " * (@max_length - line.length)
+      comment = " # "
+      evaluated = @evaluator.__eval__(line)[@remove_spaces..-1]
+
+      line + pad + comment + evaluated
+    end
+
+    def generate!
+      @lines.map { |line| generate(line) }
+    end
+
+    def to_s
+      generate!.join("\n")
+    end
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+
+require 'mcc'
+require 'riot'
+require 'riot_notifier'
+
+Riot.reporter = RiotNotifier

data/test/test_meta_code_commenter.rb

@@ -0,0 +1,56 @@
+require 'helper'
+
+class String
+  def deindent
+    gsub(/^\s*/, '')
+  end
+end
+
+context "Generates output" do
+  def asserts_output(description, input, expected, args={})
+    input.chomp!
+    expected.chomp!
+
+    asserts(description) do
+      MetaCodeCommenter::Generator.new(input.split(/\n/), args).to_s
+    end.equals(expected)
+  end
+
+  asserts_output("empty", <<-'IN', <<-'OUT')
+  IN
+  OUT
+
+  asserts_output("one line", <<-'IN', <<-'OUT')
+    hello
+  IN
+    hello # hello
+  OUT
+
+  asserts_output("one line interpolated", <<-'IN', <<-'OUT', :value => "world")
+    hello = '#{value}'
+  IN
+    hello = '#{value}'  # hello = 'world'
+  OUT
+
+  asserts_output("align lines", <<-'IN', <<-'OUT')
+    def method_call
+      method_body
+    end
+  IN
+    def method_call # def method_call
+      method_body   #   method_body
+    end             # end
+  OUT
+
+  # TODO is failing!
+  asserts_output("double quote", <<-'IN', <<-'OUT', :key => "hello", :value => "world")
+    def #{key}
+      "#{value}"
+    end
+  IN
+    def #{key}    # def hello
+      "#{value}"  #   "world"
+    end           # end
+  OUT
+
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: meta_code_commenter
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Peter Suschlik
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-21 00:00:00 +01:00
+default_executable: mcc
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: riot
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: riot_notifier
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: peter-mcc@suschlik.de
+executables: 
+- mcc
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- .watchr
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/mcc
+- lib/mcc.rb
+- lib/meta_code_commenter.rb
+- test/helper.rb
+- test/test_meta_code_commenter.rb
+has_rdoc: true
+homepage: http://github.com/splattael/meta_code_commenter
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Comments your meta code
+test_files: 
+- test/test_meta_code_commenter.rb