comment_extractor 1.0.1

data/spec/comment_extractor/code_objects_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+require 'comment_extractor/code_object'
+require 'comment_extractor/code_objects'
+
+module CommentExtractor
+  describe CodeObjects do
+    let(:file_path) { 'path/to/file' }
+
+    describe 'ClassMethods' do
+      describe '.new' do
+        subject { described_class.new(file: file_path) }
+
+        it 'initializes a instance of CodeObjects' do
+          expect(subject).to be_an_instance_of CodeObjects
+          expect(subject.file).to eql file_path
+        end
+      end
+    end
+
+    describe 'InstanceMethods' do
+      let(:described_instance) { described_class.new(file: file_path) }
+      let(:code_object) { CodeObject.new(value: 3) }
+      let(:code_object_size) { 1 }
+
+      shared_context "a extended array's method" do
+        context 'given a instance of CodeObject::Comment' do
+          it 'adds a information of self to argument' do
+            subject
+            expect(code_object.metadata[:parent]).to equal described_instance
+          end
+
+          it 'adds a code_object' do
+            expect { subject }.to change { described_instance.size }
+              .to(code_object_size).from(0)
+            expect(subject.all? { |v| v.is_a?(code_object.class) }).to be_truthy
+          end
+        end
+
+        context 'not given a instance of CodeObject::Comment' do
+          let(:code_object) { nil }
+          it { expect { subject }.to raise_error(TypeError) }
+        end
+      end
+
+      describe '#<<' do
+        subject { described_instance << code_object }
+
+        it_behaves_like "a extended array's method"
+      end
+
+      describe '#push' do
+        subject { described_instance.push code_object, code_object }
+        let(:code_object_size) { 2 }
+
+        it_behaves_like "a extended array's method"
+      end
+
+      describe '#concat' do
+        subject { described_instance.concat [code_object], [code_object] }
+        let(:code_object_size) { 2 }
+
+        it_behaves_like "a extended array's method"
+      end
+    end
+  end
+end

data/spec/comment_extractor/configuration_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+require 'comment_extractor/configuration'
+
+module CommentExtractor
+  describe Configuration do
+    describe '.new' do
+      subject { CommentExtractor::Configuration.new(options) }
+      let(:options) { { root_path: File.dirname(__FILE__) } }
+
+      it 'sets attributes to default value' do
+        expect(subject.extractors).to eql ExtractorManager.default_extractors
+        expect(subject.default_extractor).to eql Extractor::Text
+        expect(subject.use_default_extractor).to be_truthy
+      end
+    end
+
+    describe '.add_setting' do
+      before do
+        # Initializes class variables
+        @required_attributes = Configuration.class_variable_set(:@@required_attributes, {})
+        Configuration.class_variable_set(:@@required_attributes, {})
+
+        Configuration.send(:add_setting, name, option_of_setting)
+      end
+
+      after do
+        # Restores class variables
+        Configuration.class_variable_set(:@@required_attributes, @required_attributes)
+      end
+
+      subject { Configuration.new(option_of_initialization) }
+      let(:name) { :setting_name }
+      let(:option_of_setting) { {} }
+      let(:option_of_initialization) { {} }
+
+      context 'given setting name' do
+        it 'defines accessor method' do
+          should be_respond_to name
+          should be_respond_to "#{name}="
+        end
+      end
+
+      context 'given predicate option' do
+        let(:option_of_setting) { { predicate: true } }
+        let(:method) { :"#{name}?" }
+
+        it 'defines predicate method(:name?)' do
+          expect(subject).to be_respond_to(method)
+          expect(subject.send(method)).to be_falsy
+        end
+      end
+
+      context 'given required option' do
+        let(:option_of_setting) { { required: true } }
+
+        context 'when initializations configuration without required attribute' do
+          let(:message) { "Unable to initialize #{name} without attribute" }
+          it { expect { subject }.to raise_error(message) }
+        end
+
+        context 'when initializations configuration with required attribute' do
+          let(:option_of_initialization) { { name => true } }
+          it { expect { subject }.to_not raise_error }
+        end
+      end
+    end
+  end
+end

data/spec/comment_extractor/encoding_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+require 'comment_extractor/encoding'
+require 'tempfile'
+
+module CommentExtractor
+  describe Encoding do
+    describe 'ClassMethods' do
+      let(:body) { 'hello_world' }
+      let(:temp) { Tempfile.new('tempfile') }
+
+      describe '.encode' do
+        subject { described_class.encode(*[body, format].compact) }
+
+        shared_examples_for 'a text encoder' do
+          let(:expected_format_type) do
+            respond_to?(:format_expected) ? format_expected : format
+          end
+          let(:expected_body) do
+            respond_to?(:body_expected) ? body_expected : body
+          end
+
+          it 'works' do
+            expect(subject).to eql expected_body
+            expect(subject.encoding).to eql expected_format_type
+          end
+        end
+
+        context 'given only a raw text' do
+          let(:format) { nil }
+          let(:format_expected) { ::Encoding::UTF_8 }
+
+          it_behaves_like 'a text encoder'
+        end
+
+        context 'given a text contains bom' do
+          let(:body) { "\xef\xbb\xbf"  }
+          let(:format) { nil }
+          let(:format_expected) { ::Encoding::UTF_8 }
+
+          it_behaves_like 'a text encoder'
+        end
+
+        context "given #{::Encoding::UTF_8} as encoding type" do
+          let(:format) { ::Encoding::UTF_8 }
+
+          it_behaves_like 'a text encoder'
+        end
+
+        context 'given a invalid text' do
+          let(:body) { "\u00D7"  }
+          let(:format) { ::Encoding::US_ASCII }
+          let(:expected_error) { ::Encoding::UndefinedConversionError }
+
+          it { expect { subject }.to raise_error(expected_error) }
+        end
+      end
+
+      describe '.read_file' do
+        subject { Encoding.read_file(temp.path) }
+
+        before do
+          temp.write(body)
+          temp.flush
+        end
+
+        context 'given a file path' do
+          it 'returns a encoded content' do
+            expect(described_class).to receive(:encode)
+            .at_least(:once)
+            .with(body) { |v| v }
+            expect(subject).to eql body
+          end
+        end
+      end
+    end
+  end
+end

data/spec/comment_extractor/extractor/c_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'comment_extractor/extractor/c'
+
+class CommentExtractor::Extractor
+  describe C do
+    it_behaves_like 'extracting comments from', 'c.c'
+    it_behaves_like 'detecting filename', 'file.c'
+  end
+end

data/spec/comment_extractor/extractor/cc_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'comment_extractor/extractor/cc'
+
+class CommentExtractor::Extractor
+  describe Cc do
+    it_behaves_like 'extracting comments from', 'cc.cc'
+    it_behaves_like 'detecting filename', 'file.cc'
+  end
+end

data/spec/comment_extractor/extractor/class_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'comment_extractor/extractor/class'
+
+class CommentExtractor::Extractor
+  describe Class do
+    pending 'Please give me a sample file'
+    it_behaves_like 'detecting filename', 'file.class'
+  end
+end

data/spec/comment_extractor/extractor/clojure_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'comment_extractor/extractor/clojure'
+
+class CommentExtractor::Extractor
+  describe Clojure do
+    it_behaves_like 'extracting comments from', 'clojure.clj'
+    it_behaves_like 'detecting filename', 'file.clj'
+  end
+end

data/spec/comment_extractor/extractor/coffee_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'comment_extractor/extractor/coffee'
+
+class CommentExtractor::Extractor
+  describe Coffee do
+    it_behaves_like 'extracting comments from', 'coffee.coffee'
+    it_behaves_like 'detecting filename', 'file.coffee'
+  end
+end

data/spec/comment_extractor/extractor/cpp_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'comment_extractor/extractor/cpp'
+
+class CommentExtractor::Extractor
+  describe Cpp do
+    it_behaves_like 'extracting comments from', 'cpp.cpp'
+    it_behaves_like 'detecting filename', 'file.cpp'
+  end
+end

data/spec/comment_extractor/extractor/cs_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'comment_extractor/extractor/cs'
+
+class CommentExtractor::Extractor
+  describe Cs do
+    it_behaves_like 'extracting comments from', 'cs.cs'
+    it_behaves_like 'detecting filename', 'file.cs'
+  end
+end

data/spec/comment_extractor/extractor/css_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'comment_extractor/extractor/css'
+
+class CommentExtractor::Extractor
+  describe Css do
+    it_behaves_like 'extracting comments from', 'css.css'
+    it_behaves_like 'detecting filename', 'file.css'
+  end
+end

data/spec/comment_extractor/extractor/cxx_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'comment_extractor/extractor/cxx'
+
+class CommentExtractor::Extractor
+  describe Cxx do
+    pending 'Please give me sample file'
+    it_behaves_like 'detecting filename', 'file.cxx'
+  end
+end

data/spec/comment_extractor/extractor/d_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+require 'comment_extractor/extractor/d'
+
+class CommentExtractor::Extractor
+  describe D do
+    it_behaves_like 'detecting shebang', '/usr/local/bin/dmd'
+    it_behaves_like 'extracting comments from', 'd.d'
+    it_behaves_like 'detecting filename', 'file.d'
+  end
+end

data/spec/comment_extractor/extractor/erlang_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+require 'comment_extractor/extractor/erlang'
+
+class CommentExtractor::Extractor
+  describe Erlang do
+    it_behaves_like 'detecting shebang', '/usr/bin/env escript'
+    it_behaves_like 'extracting comments from', 'erlang.es'
+    it_behaves_like 'detecting filename', 'file.es'
+  end
+end

data/spec/comment_extractor/extractor/fortran_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'comment_extractor/extractor/fortran'
+
+class CommentExtractor::Extractor
+  describe Fortran do
+    it_behaves_like 'extracting comments from', 'fortran.f'
+    it_behaves_like 'detecting filename', 'file.f'
+  end
+end

data/spec/comment_extractor/extractor/go_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'comment_extractor/extractor/go'
+
+class CommentExtractor::Extractor
+  describe Go do
+    it_behaves_like 'extracting comments from', 'golang.go'
+    it_behaves_like 'detecting filename', 'file.go'
+  end
+end

data/spec/comment_extractor/extractor/h_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'comment_extractor/extractor/h'
+
+class CommentExtractor::Extractor
+  describe H do
+    pending 'Please give me sample file...'
+    it_behaves_like 'detecting filename', 'file.h'
+  end
+end

data/spec/comment_extractor/extractor/haml_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'comment_extractor/extractor/haml'
+
+class CommentExtractor::Extractor
+  describe Haml do
+    it_behaves_like 'extracting comments from', 'haml.haml'
+    it_behaves_like 'detecting filename', 'file.haml'
+  end
+end

data/spec/comment_extractor/extractor/haskell_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'comment_extractor/extractor/haskell'
+
+class CommentExtractor::Extractor
+  describe Haskell do
+    it_behaves_like 'extracting comments from', 'haskell.hs'
+    it_behaves_like 'detecting filename', 'file.hs'
+  end
+end

data/spec/comment_extractor/extractor/hpp_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'comment_extractor/extractor/hpp'
+
+class CommentExtractor::Extractor
+  describe Hpp do
+    pending 'Please give me sample file'
+    it_behaves_like 'detecting filename', 'file.hpp'
+  end
+end

data/spec/comment_extractor/extractor/html_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'comment_extractor/extractor/html'
+
+class CommentExtractor::Extractor
+  describe Html do
+    it_behaves_like 'extracting comments from', 'html.html'
+    it_behaves_like 'detecting filename', 'file.html'
+  end
+end

data/spec/comment_extractor/extractor/java_script_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+require 'comment_extractor/extractor/java_script'
+
+class CommentExtractor::Extractor
+  describe JavaScript do
+    it_behaves_like 'detecting shebang', '/usr/local/bin/node'
+    it_behaves_like 'extracting comments from', 'java_script.js'
+    it_behaves_like 'detecting filename', 'file.js'
+  end
+end

data/spec/comment_extractor/extractor/java_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'comment_extractor/extractor/java'
+
+class CommentExtractor::Extractor
+  describe Java do
+    it_behaves_like 'extracting comments from', 'java.java'
+    it_behaves_like 'detecting filename', 'file.java'
+  end
+end

data/spec/comment_extractor/extractor/lisp_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'comment_extractor/extractor/lisp'
+
+class CommentExtractor::Extractor
+  describe Lisp do
+    it_behaves_like 'extracting comments from', 'lisp.el'
+    it_behaves_like 'detecting filename', 'file.el'
+  end
+end

data/spec/comment_extractor/extractor/lua_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'comment_extractor/extractor/lua'
+
+class CommentExtractor::Extractor
+  describe Lua do
+    it_behaves_like 'extracting comments from', 'lua.lua'
+    it_behaves_like 'detecting filename', 'file.lua'
+  end
+end

data/spec/comment_extractor/extractor/m_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'comment_extractor/extractor/m'
+
+class CommentExtractor::Extractor
+  describe M do
+    pending 'Please give me sample file'
+    it_behaves_like 'detecting filename', 'file.m'
+  end
+end

data/spec/comment_extractor/extractor/markdown_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'comment_extractor/extractor/markdown'
+
+class CommentExtractor::Extractor
+  describe Markdown, disabled: true do
+    it_behaves_like 'detecting filename', 'file.mkd', 'file.md', 'file.markdown'
+  end
+end

data/spec/comment_extractor/extractor/mm_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'comment_extractor/extractor/mm'
+
+class CommentExtractor::Extractor
+  describe Mm do
+    pending 'Please give me sample file'
+    it_behaves_like 'detecting filename', 'file.mm'
+  end
+end

data/spec/comment_extractor/extractor/perl_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'comment_extractor/extractor/perl'
+
+class CommentExtractor::Extractor
+  describe Perl do
+    it_behaves_like 'extracting comments from', 'perl.pl'
+    it_behaves_like 'detecting filename', 'file.pl'
+  end
+end

data/spec/comment_extractor/extractor/php_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'comment_extractor/extractor/php'
+
+class CommentExtractor::Extractor
+  describe Php do
+    it_behaves_like 'extracting comments from', 'php.php'
+    it_behaves_like 'detecting filename', 'file.php'
+  end
+end

data/spec/comment_extractor/extractor/python_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'comment_extractor/extractor/python'
+
+class CommentExtractor::Extractor
+  describe Python do
+    it_behaves_like 'extracting comments from', 'python.py'
+    it_behaves_like 'detecting filename', 'file.py'
+  end
+end

data/spec/comment_extractor/extractor/ruby_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+require 'comment_extractor/extractor/ruby'
+
+class CommentExtractor::Extractor
+  describe Ruby do
+    it_behaves_like 'detecting shebang', '/usr/local/bin/ruby'
+    it_behaves_like 'extracting comments from', 'ruby.rb'
+
+    filenames = %w[file.rb Gemfile Rakefile file.gemspec Guardfile config.ru]
+    it_behaves_like 'detecting filename', *filenames
+  end
+end

data/spec/comment_extractor/extractor/sass_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'comment_extractor/extractor/sass'
+
+class CommentExtractor::Extractor
+  describe Sass do
+    it_behaves_like 'extracting comments from', 'sass.sass'
+    it_behaves_like 'detecting filename', 'file.sass'
+  end
+end

data/spec/comment_extractor/extractor/scala_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'comment_extractor/extractor/scala'
+
+class CommentExtractor::Extractor
+  describe Scala do
+    it_behaves_like 'extracting comments from', 'scala.scala'
+    it_behaves_like 'detecting filename', 'file.scala'
+  end
+end

data/spec/comment_extractor/extractor/scss_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'comment_extractor/extractor/scss'
+
+class CommentExtractor::Extractor
+  describe Scss do
+    it_behaves_like 'extracting comments from', 'scss.scss'
+    it_behaves_like 'detecting filename', 'file.scss'
+  end
+end

data/spec/comment_extractor/extractor/shell_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'comment_extractor/extractor/shell'
+
+class CommentExtractor::Extractor
+  describe Shell do
+    it_behaves_like 'extracting comments from', 'shell.sh'
+    it_behaves_like 'detecting filename', 'file.sh', 'file.zsh', 'file.bash', 'bashrc', 'zshrc'
+  end
+end

data/spec/comment_extractor/extractor/sqf_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'comment_extractor/extractor/sqf'
+
+class CommentExtractor::Extractor
+  describe Sqf do
+    pending 'Please give me sample code'
+    it_behaves_like 'detecting filename', 'file.sqf'
+  end
+end

data/spec/comment_extractor/extractor/sql_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'comment_extractor/extractor/sql'
+
+class CommentExtractor::Extractor
+  describe Sql do
+    it_behaves_like 'extracting comments from', 'sql.sql'
+    it_behaves_like 'detecting filename', 'file.sql'
+  end
+end

data/spec/comment_extractor/extractor/sqs_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'comment_extractor/extractor/sqs'
+
+class CommentExtractor::Extractor
+  describe Sqs, disabled: true do
+    pending 'Please give me sample code'
+    it_behaves_like 'detecting filename', 'file.sqs'
+  end
+end

data/spec/comment_extractor/extractor/tex_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'comment_extractor/extractor/tex'
+
+class CommentExtractor::Extractor
+  describe Tex do
+    it_behaves_like 'extracting comments from', 'tex.tex'
+    it_behaves_like 'detecting filename', 'file.tex'
+  end
+end

data/spec/comment_extractor/extractor/text_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+require 'comment_extractor/extractor/text'
+
+describe CommentExtractor::Extractor::Text do
+  it_behaves_like 'extracting comments from', 'text.txt'
+  it_behaves_like 'detecting filename', 'file.txt'
+end

data/spec/comment_extractor/extractor/yaml_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'comment_extractor/extractor/yaml'
+
+class CommentExtractor::Extractor
+  describe Yaml do
+    it_behaves_like 'extracting comments from', 'yaml.yml'
+    it_behaves_like 'detecting filename', 'file.yml'
+  end
+end