comment_extractor 1.0.1

data/spec/support/rspec/comment_extractor/matchers/extract_comment.rb

@@ -0,0 +1,58 @@
+module RSpec::CommentExtractor::Matchers
+  module ExtractComment
+    class ExtractCommentMatcher < RSpec::Matchers::BuiltIn::BaseMatcher
+      def initialize(scope, comment_list = {})
+        @scope = scope
+        @comment_list = comment_list
+        @failure_case = []
+      end
+
+      # @api private
+      def matches?(list_or_block)
+        comments = list_or_block.is_a?(Proc) ? list_or_block.call : list_or_block
+        @target_comment_list = @comment_list.dup
+
+        comments.each do |comment_object|
+          comment_expected = @target_comment_list.delete(comment_object.line)
+          unless comment_expected == comment_object.value
+            case_array = [comment_object.line, comment_expected, comment_object]
+            @failure_case << case_array
+          end
+        end
+
+        # all comemnts are extracted
+        @failure_case.empty? && @target_comment_list.empty?
+      end
+
+      def failure_message_for_should
+        messages = []
+        @failure_case.each do |(line, expected, comment_object)|
+          messages << <<-MESSAGE.gsub(/^\s*/, '')
+          expected not to extract comment in #{line}
+          expected: '#{comment_object.value}'
+          got: '#{expected}'
+          MESSAGE
+        end
+
+        @target_comment_list.each do |line, comment|
+          messages << <<-MESSAGE.gsub(/^\s*/, '')
+          expected not to extract comment in #{line}
+          expected: '#{comment}'
+          got: not extracted
+          MESSAGE
+        end
+
+        messages.join("\n")
+      end
+
+      def failure_message_for_should_not
+        # [todo] - implements here
+        # "expected not to render #{expected.inspect}, but did"
+      end
+    end
+
+    def extract_comment(*args)
+      ExtractCommentMatcher.new(self, *args)
+    end
+  end
+end

data/spec/support/rspec/comment_extractor/matchers.rb

@@ -0,0 +1,7 @@
+require 'rspec/expectations'
+require 'rspec/comment_extractor/matchers/extract_comment'
+
+module RSpec::CommentExtractor
+  module Matchers
+  end
+end

data/spec/support/rspec/comment_extractor.rb

@@ -0,0 +1,6 @@
+module RSpec
+  module CommentExtractor
+    autoload :ExtractorExampleGroup, 'rspec/comment_extractor/extractor_example_group'
+    autoload :Matchers, 'rspec/comment_extractor/matchers'
+  end
+end

metadata

@@ -0,0 +1,370 @@
+--- !ruby/object:Gem::Specification
+name: comment_extractor
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- alpaca-tc
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: comment_extractor extracts comments from source code
+email: alpaca-tc@alpaca.tc
+executables:
+- comment_parser_debug
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/comment_parser_debug
+- lib/comment_extractor.rb
+- lib/comment_extractor/code_object.rb
+- lib/comment_extractor/code_object/comment.rb
+- lib/comment_extractor/code_objects.rb
+- lib/comment_extractor/configuration.rb
+- lib/comment_extractor/encoding.rb
+- lib/comment_extractor/extractor.rb
+- lib/comment_extractor/extractor/c.rb
+- lib/comment_extractor/extractor/cc.rb
+- lib/comment_extractor/extractor/class.rb
+- lib/comment_extractor/extractor/clojure.rb
+- lib/comment_extractor/extractor/coffee.rb
+- lib/comment_extractor/extractor/concerns/simple_extractor.rb
+- lib/comment_extractor/extractor/concerns/slash_extractor.rb
+- lib/comment_extractor/extractor/cpp.rb
+- lib/comment_extractor/extractor/cs.rb
+- lib/comment_extractor/extractor/css.rb
+- lib/comment_extractor/extractor/cxx.rb
+- lib/comment_extractor/extractor/d.rb
+- lib/comment_extractor/extractor/erlang.rb
+- lib/comment_extractor/extractor/fortran.rb
+- lib/comment_extractor/extractor/go.rb
+- lib/comment_extractor/extractor/h.rb
+- lib/comment_extractor/extractor/haml.rb
+- lib/comment_extractor/extractor/haskell.rb
+- lib/comment_extractor/extractor/hpp.rb
+- lib/comment_extractor/extractor/html.rb
+- lib/comment_extractor/extractor/java.rb
+- lib/comment_extractor/extractor/java_script.rb
+- lib/comment_extractor/extractor/lisp.rb
+- lib/comment_extractor/extractor/lua.rb
+- lib/comment_extractor/extractor/m.rb
+- lib/comment_extractor/extractor/markdown.rb
+- lib/comment_extractor/extractor/mm.rb
+- lib/comment_extractor/extractor/perl.rb
+- lib/comment_extractor/extractor/php.rb
+- lib/comment_extractor/extractor/python.rb
+- lib/comment_extractor/extractor/ruby.rb
+- lib/comment_extractor/extractor/sass.rb
+- lib/comment_extractor/extractor/scala.rb
+- lib/comment_extractor/extractor/scss.rb
+- lib/comment_extractor/extractor/shell.rb
+- lib/comment_extractor/extractor/sqf.rb
+- lib/comment_extractor/extractor/sql.rb
+- lib/comment_extractor/extractor/sqs.rb
+- lib/comment_extractor/extractor/tex.rb
+- lib/comment_extractor/extractor/text.rb
+- lib/comment_extractor/extractor/yaml.rb
+- lib/comment_extractor/extractor_manager.rb
+- lib/comment_extractor/file.rb
+- lib/comment_extractor/parser.rb
+- lib/comment_extractor/smart_string_scanner.rb
+- lib/comment_extractor/version.rb
+- spec/assets/binary_file
+- spec/assets/shebang_file
+- spec/assets/source_code/c.c
+- spec/assets/source_code/cc.cc
+- spec/assets/source_code/class
+- spec/assets/source_code/clojure.clj
+- spec/assets/source_code/coffee.coffee
+- spec/assets/source_code/cpp.cpp
+- spec/assets/source_code/cs.cs
+- spec/assets/source_code/css.css
+- spec/assets/source_code/cxx
+- spec/assets/source_code/d.d
+- spec/assets/source_code/erlang.es
+- spec/assets/source_code/fortran.f
+- spec/assets/source_code/golang.go
+- spec/assets/source_code/h
+- spec/assets/source_code/haml.haml
+- spec/assets/source_code/haskell.hs
+- spec/assets/source_code/hpp
+- spec/assets/source_code/html.html
+- spec/assets/source_code/java.java
+- spec/assets/source_code/java_script.js
+- spec/assets/source_code/lisp.el
+- spec/assets/source_code/lua.lua
+- spec/assets/source_code/m
+- spec/assets/source_code/mm
+- spec/assets/source_code/perl.pl
+- spec/assets/source_code/php.php
+- spec/assets/source_code/python.py
+- spec/assets/source_code/ruby.rb
+- spec/assets/source_code/sass.sass
+- spec/assets/source_code/scala.scala
+- spec/assets/source_code/scss.scss
+- spec/assets/source_code/shell.sh
+- spec/assets/source_code/sqf
+- spec/assets/source_code/sql.sql
+- spec/assets/source_code/sqs
+- spec/assets/source_code/tex.tex
+- spec/assets/source_code/text.txt
+- spec/assets/source_code/vim
+- spec/assets/source_code/yaml.yml
+- spec/assets/stripper/children/children
+- spec/assets/stripper/children/children.c
+- spec/assets/stripper/children/children.js
+- spec/assets/stripper/children/children.o
+- spec/assets/stripper/children/children.rb
+- spec/assets/stripper/test
+- spec/assets/stripper/test.c
+- spec/assets/stripper/test.js
+- spec/assets/stripper/test.o
+- spec/assets/stripper/test.rb
+- spec/comment_extractor/code_object/comment_spec.rb
+- spec/comment_extractor/code_object_spec.rb
+- spec/comment_extractor/code_objects_spec.rb
+- spec/comment_extractor/configuration_spec.rb
+- spec/comment_extractor/encoding_spec.rb
+- spec/comment_extractor/extractor/c_spec.rb
+- spec/comment_extractor/extractor/cc_spec.rb
+- spec/comment_extractor/extractor/class_spec.rb
+- spec/comment_extractor/extractor/clojure_spec.rb
+- spec/comment_extractor/extractor/coffee_spec.rb
+- spec/comment_extractor/extractor/cpp_spec.rb
+- spec/comment_extractor/extractor/cs_spec.rb
+- spec/comment_extractor/extractor/css_spec.rb
+- spec/comment_extractor/extractor/cxx_spec.rb
+- spec/comment_extractor/extractor/d_spec.rb
+- spec/comment_extractor/extractor/erlang_spec.rb
+- spec/comment_extractor/extractor/fortran_spec.rb
+- spec/comment_extractor/extractor/go_spec.rb
+- spec/comment_extractor/extractor/h_spec.rb
+- spec/comment_extractor/extractor/haml_spec.rb
+- spec/comment_extractor/extractor/haskell_spec.rb
+- spec/comment_extractor/extractor/hpp_spec.rb
+- spec/comment_extractor/extractor/html_spec.rb
+- spec/comment_extractor/extractor/java_script_spec.rb
+- spec/comment_extractor/extractor/java_spec.rb
+- spec/comment_extractor/extractor/lisp_spec.rb
+- spec/comment_extractor/extractor/lua_spec.rb
+- spec/comment_extractor/extractor/m_spec.rb
+- spec/comment_extractor/extractor/markdown_spec.rb
+- spec/comment_extractor/extractor/mm_spec.rb
+- spec/comment_extractor/extractor/perl_spec.rb
+- spec/comment_extractor/extractor/php_spec.rb
+- spec/comment_extractor/extractor/python_spec.rb
+- spec/comment_extractor/extractor/ruby_spec.rb
+- spec/comment_extractor/extractor/sass_spec.rb
+- spec/comment_extractor/extractor/scala_spec.rb
+- spec/comment_extractor/extractor/scss_spec.rb
+- spec/comment_extractor/extractor/shell_spec.rb
+- spec/comment_extractor/extractor/sqf_spec.rb
+- spec/comment_extractor/extractor/sql_spec.rb
+- spec/comment_extractor/extractor/sqs_spec.rb
+- spec/comment_extractor/extractor/tex_spec.rb
+- spec/comment_extractor/extractor/text_spec.rb
+- spec/comment_extractor/extractor/yaml_spec.rb
+- spec/comment_extractor/extractor_manager_spec.rb
+- spec/comment_extractor/extractor_spec.rb
+- spec/comment_extractor/file_spec.rb
+- spec/comment_extractor/parser_spec.rb
+- spec/comment_extractor/smart_string_scanner_spec.rb
+- spec/comment_extractor/version_spec.rb
+- spec/comment_extractor_spec.rb
+- spec/spec_helper.rb
+- spec/support/rspec/comment_extractor.rb
+- spec/support/rspec/comment_extractor/extractor_example_group.rb
+- spec/support/rspec/comment_extractor/matchers.rb
+- spec/support/rspec/comment_extractor/matchers/extract_comment.rb
+homepage: https://github.com/alpaca-tc/comment_extractor
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: a simple comment extractor
+test_files:
+- spec/assets/binary_file
+- spec/assets/shebang_file
+- spec/assets/source_code/c.c
+- spec/assets/source_code/cc.cc
+- spec/assets/source_code/class
+- spec/assets/source_code/clojure.clj
+- spec/assets/source_code/coffee.coffee
+- spec/assets/source_code/cpp.cpp
+- spec/assets/source_code/cs.cs
+- spec/assets/source_code/css.css
+- spec/assets/source_code/cxx
+- spec/assets/source_code/d.d
+- spec/assets/source_code/erlang.es
+- spec/assets/source_code/fortran.f
+- spec/assets/source_code/golang.go
+- spec/assets/source_code/h
+- spec/assets/source_code/haml.haml
+- spec/assets/source_code/haskell.hs
+- spec/assets/source_code/hpp
+- spec/assets/source_code/html.html
+- spec/assets/source_code/java.java
+- spec/assets/source_code/java_script.js
+- spec/assets/source_code/lisp.el
+- spec/assets/source_code/lua.lua
+- spec/assets/source_code/m
+- spec/assets/source_code/mm
+- spec/assets/source_code/perl.pl
+- spec/assets/source_code/php.php
+- spec/assets/source_code/python.py
+- spec/assets/source_code/ruby.rb
+- spec/assets/source_code/sass.sass
+- spec/assets/source_code/scala.scala
+- spec/assets/source_code/scss.scss
+- spec/assets/source_code/shell.sh
+- spec/assets/source_code/sqf
+- spec/assets/source_code/sql.sql
+- spec/assets/source_code/sqs
+- spec/assets/source_code/tex.tex
+- spec/assets/source_code/text.txt
+- spec/assets/source_code/vim
+- spec/assets/source_code/yaml.yml
+- spec/assets/stripper/children/children
+- spec/assets/stripper/children/children.c
+- spec/assets/stripper/children/children.js
+- spec/assets/stripper/children/children.o
+- spec/assets/stripper/children/children.rb
+- spec/assets/stripper/test
+- spec/assets/stripper/test.c
+- spec/assets/stripper/test.js
+- spec/assets/stripper/test.o
+- spec/assets/stripper/test.rb
+- spec/comment_extractor/code_object/comment_spec.rb
+- spec/comment_extractor/code_object_spec.rb
+- spec/comment_extractor/code_objects_spec.rb
+- spec/comment_extractor/configuration_spec.rb
+- spec/comment_extractor/encoding_spec.rb
+- spec/comment_extractor/extractor/c_spec.rb
+- spec/comment_extractor/extractor/cc_spec.rb
+- spec/comment_extractor/extractor/class_spec.rb
+- spec/comment_extractor/extractor/clojure_spec.rb
+- spec/comment_extractor/extractor/coffee_spec.rb
+- spec/comment_extractor/extractor/cpp_spec.rb
+- spec/comment_extractor/extractor/cs_spec.rb
+- spec/comment_extractor/extractor/css_spec.rb
+- spec/comment_extractor/extractor/cxx_spec.rb
+- spec/comment_extractor/extractor/d_spec.rb
+- spec/comment_extractor/extractor/erlang_spec.rb
+- spec/comment_extractor/extractor/fortran_spec.rb
+- spec/comment_extractor/extractor/go_spec.rb
+- spec/comment_extractor/extractor/h_spec.rb
+- spec/comment_extractor/extractor/haml_spec.rb
+- spec/comment_extractor/extractor/haskell_spec.rb
+- spec/comment_extractor/extractor/hpp_spec.rb
+- spec/comment_extractor/extractor/html_spec.rb
+- spec/comment_extractor/extractor/java_script_spec.rb
+- spec/comment_extractor/extractor/java_spec.rb
+- spec/comment_extractor/extractor/lisp_spec.rb
+- spec/comment_extractor/extractor/lua_spec.rb
+- spec/comment_extractor/extractor/m_spec.rb
+- spec/comment_extractor/extractor/markdown_spec.rb
+- spec/comment_extractor/extractor/mm_spec.rb
+- spec/comment_extractor/extractor/perl_spec.rb
+- spec/comment_extractor/extractor/php_spec.rb
+- spec/comment_extractor/extractor/python_spec.rb
+- spec/comment_extractor/extractor/ruby_spec.rb
+- spec/comment_extractor/extractor/sass_spec.rb
+- spec/comment_extractor/extractor/scala_spec.rb
+- spec/comment_extractor/extractor/scss_spec.rb
+- spec/comment_extractor/extractor/shell_spec.rb
+- spec/comment_extractor/extractor/sqf_spec.rb
+- spec/comment_extractor/extractor/sql_spec.rb
+- spec/comment_extractor/extractor/sqs_spec.rb
+- spec/comment_extractor/extractor/tex_spec.rb
+- spec/comment_extractor/extractor/text_spec.rb
+- spec/comment_extractor/extractor/yaml_spec.rb
+- spec/comment_extractor/extractor_manager_spec.rb
+- spec/comment_extractor/extractor_spec.rb
+- spec/comment_extractor/file_spec.rb
+- spec/comment_extractor/parser_spec.rb
+- spec/comment_extractor/smart_string_scanner_spec.rb
+- spec/comment_extractor/version_spec.rb
+- spec/comment_extractor_spec.rb
+- spec/spec_helper.rb
+- spec/support/rspec/comment_extractor.rb
+- spec/support/rspec/comment_extractor/extractor_example_group.rb
+- spec/support/rspec/comment_extractor/matchers.rb
+- spec/support/rspec/comment_extractor/matchers/extract_comment.rb