source2swagger 0.0.1 → 0.0.2

data/README.md

@@ -1,4 +1,3 @@
-
 ## Description
 
 Coming soon...
@@ -23,10 +22,21 @@ Coming soon...
 
 #### Example
 
-      $ bin/souce2swagger -i ~/project/lib -e "rb" -c "##~"_
+      $ bin/source2swagger -i ~/project/lib -e "rb" -c "##~"_
 
 This will output the Swagger compatible JSON specs on the terminal. 
 
+For this example the file annotated with the swagger spec are ruby files (*-e "rb"*). The annotations
+started with *##~* to distinguish them from normal ruby comments that start *#*. 
+
+The source code is on the directory *~/project/lib* , note that the path is handled recursively, it will analyze all ruby
+file under the declared path.
+
+You can also target a single file setting the option *-f* 
+
+      $ bin/source2swagger -f ~/data/test/sample3.rb -c "##~"_
+
+
 Add *-o /tmp* and it will write the JSON file(s) to */tmp*
 
 #### Contributions
@@ -122,7 +132,7 @@ Check [test/data/sample3.rb](https://github.com/solso/source2swagger/blob/master
 
 (partial)
 
-For a more comprehensive specification of the fields needes to declare your API on the Swagger format you can always go to the [source](http://swagger.wordnik.com/spec) 
+For a more comprehensive specification of the fields needed to declare your API on the Swagger format you can always go to the [source](http://swagger.wordnik.com/spec) 
 
       $ROOT
 

data/bin/source2swagger

@@ -21,9 +21,10 @@ opt_input = nil
 opt_output = nil
 opt_comment = nil
 opt_extension = nil
+opt_filename = nil
 
 parser = OptionParser.new do |parser|
-  parser.on('-i','--input PATH', 'Directory of the input source code') do |value|
+  parser.on('-i','--input PATH', 'Directory of the annotated source code') do |value|
     opt_input = value
   end
 
@@ -31,6 +32,10 @@ parser = OptionParser.new do |parser|
     opt_extension = value
   end
 
+  parser.on('-f','--file FILENAME', 'Overwrites options: -i and -e. Takes a single annotated source code file') do |value|
+    opt_filename = value
+  end
+
   parser.on('-c','--comment ("##~"|"//~")','Comment tag used to write docs') do |value|
     opt_comment = value
   end
@@ -39,14 +44,23 @@ parser = OptionParser.new do |parser|
     opt_output = value
   end
 
-  parser.parse!
+  begin
+    parser.parse!
+  rescue Exception => e
+    puts e.message
+    puts parser
+    abort
+  end
 end
 
-unless opt_extension and opt_input and opt_comment
+
+puts opt_filename
+
+unless ((opt_extension and opt_input and opt_comment) || (opt_filename and opt_comment))
   puts parser
   abort
 end
-
+ 
 def save(results, output_path)
   results.each do |k,v|
     puts "  Saving API #{k} to #{output_path}/#{k}.json" 
@@ -63,22 +77,38 @@ def print(results)
   end
 end
 
-def run(input, extension, comment, output)
+def run(input, extension, comment, output, filename)
   reader = SwaggerReader.new
   $_swaggerhash = Hash.new
 
-  code = reader.analyze_all_files(input,extension,comment)
-  results = reader.process_code(code) unless code.nil? || code.empty?
-
-  puts "Swagger API in #{ARGV[0]}/**/*.#{ARGV[1]}: #{results.size} API\n"
+  if filename.nil?
+    code = reader.analyze_all_files(input,extension,comment)
+  else 
+    code = reader.analyze_file(filename, comment)
+  end
+  
+  begin
+    results = reader.process_code(code) unless code.nil? || code.empty?
+  rescue SwaggerReaderException => e
+    puts "There is a problem with your swagger annotation. See below...\n\n"
+    puts e.inspect
+  end  
+
+  if filename.nil?
+    puts "Swagger API in #{input}/**/*.#{extension}: #{results.size} API\n"
+  else
+    puts "Swagger API in #{filename}: #{results.size} API\n"
+  end
+  
   if output.nil?
     print(results)
   else
     save(results,output)
   end
+  
   puts "Done!"
 
 end
 
 
-run(opt_input, opt_extension, opt_comment, opt_output)
+run(opt_input, opt_extension, opt_comment, opt_output, opt_filename)

data/lib/swagger_reader.rb

@@ -47,7 +47,7 @@ class SwaggerReader
     cont = 0
     code[:code].each do |code_line|
       code_line.strip!        
-      if code_line[0]=='@'
+      if code_line[0]=="@"[0]
         tmp_vars[:code] << code_line.gsub('@',' ')
         tmp_vars[:line_number] << code[:line_number][cont]
         tmp_vars[:file] << code[:file][cont]

data/source2swagger.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
-  gem.version       = '0.0.1'
+  gem.version       = '0.0.2'
 
   gem.add_dependency 'json'
 end

data/test/test_helper.rb

@@ -1,7 +1,8 @@
+require 'rubygems'
 require 'test/unit'
+require 'json'
 require 'swagger_hash'
 require 'swagger_reader'
-require 'json'
 
 $:.unshift(File.expand_path(File.dirname(__FILE__) + '/../lib'))
 

data/test/unit/swagger_reader_test.rb

@@ -117,7 +117,7 @@ class SwaggerReaderTest < Test::Unit::TestCase
       api1 = reader.process_code(code)
       assert_equal true, false
     rescue Exception => e
-      assert_equal "Error parsing source files at #{File.dirname(__FILE__)}/../data/sample_bad2.rb:9\n#<SyntaxError: (eval):1: unterminated string meets end of file>", e.to_s
+      assert_equal "Error parsing source files at #{File.dirname(__FILE__)}/../data/sample_bad2.rb:9", e.message.split("\n").first
     end
 
   end
@@ -131,7 +131,7 @@ class SwaggerReaderTest < Test::Unit::TestCase
       api1 = reader.process_code(code)
       assert_equal true, false
     rescue Exception => e
-      assert_equal "Error parsing source files at #{File.dirname(__FILE__)}/../data/sample_bad1.rb:17\n#<SyntaxError: (eval):1: syntax error, unexpected keyword_end, expecting $end\n...=> \"API down\", :code => 500;end = a.operations.add;out = {:a...\n...                               ^>", e.to_s
+      assert_equal "Error parsing source files at #{File.dirname(__FILE__)}/../data/sample_bad1.rb:17", e.message.split("\n").first
     end
 
   end
@@ -145,7 +145,7 @@ class SwaggerReaderTest < Test::Unit::TestCase
       api1 = reader.process_code(code)
       assert_equal true, false
     rescue Exception => e
-      assert_equal "Error parsing source files at #{File.dirname(__FILE__)}/../data/sample_bad3.rb:17\n#<NameError: undefined local variable or method `error_sanitize_NOT_YET_DEFINED' ", e.to_s.split("for")[0].to_s
+      assert_equal "Error parsing source files at #{File.dirname(__FILE__)}/../data/sample_bad3.rb:17", e.message.split("\n").first
 
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: source2swagger
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-17 00:00:00.000000000Z
+date: 2012-06-19 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &2162299820 !ruby/object:Gem::Requirement
+  requirement: &2154849880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2162299820
+  version_requirements: *2154849880
 description: Tool for converting comments to Swagger JSON specification
 email: josep@3scale.net
 executables: