social_snippet 0.0.1 → 0.0.2

data/spec/lib/tag_parser_spec.rb

@@ -0,0 +1,173 @@
+require "spec_helper"
+
+describe SocialSnippet::TagParser do
+
+  describe "#find_snip_tags" do
+
+    context "no @snip tags" do
+
+      let(:input_text) do
+        [
+          'input text',
+        ].join($/)
+      end
+
+      it "returns an empty array" do
+        expect(SocialSnippet::TagParser.find_snip_tags(input_text)).to eq []
+      end
+
+    end # no snip tags
+
+    context "single @snip tag" do
+
+      let(:input_text) do
+        [
+          '#include <stdio.h>',
+          '',
+          '// @snip <path/to/file.c>',
+          '',
+          'int main() {',
+          '    func();',
+          '    return 0;',
+          '}',
+        ].join($/)
+      end
+
+      context "result" do
+
+        let(:result) { SocialSnippet::TagParser.find_snip_tags(input_text) }
+        
+        it "has one element" do
+          expect(result.length).to eq 1
+        end
+
+        context "line_no" do
+          it { expect(result[0][:line_no]).to eq 2 }
+        end
+
+        context "tag.to_snippet_tag" do
+          it { expect(result[0][:tag].to_snippet_tag).to eq "// @snippet <path/to/file.c>" }
+        end
+
+      end
+
+    end # a snip tag
+
+    context "multi @snip tags" do
+
+      let(:input_text) do
+        [
+          '#include <stdio.h>',
+          '',
+          '// @snip <path/to/file1.c>',
+          '// @snip <./path/to/file2.c>',
+          '',
+          'int main() {',
+          '    func();',
+          '    return 0;',
+          '}',
+        ].join($/)
+      end
+
+      context "result" do
+
+        let(:result) { SocialSnippet::TagParser.find_snip_tags(input_text) }
+
+        it "has two elements" do
+          expect(result.length).to eq 2
+        end
+
+        context "line_no" do
+          it { expect(result[0][:line_no]).to eq 2 }
+          it { expect(result[1][:line_no]).to eq 3 }
+        end
+
+        context "tag.to_snippet_tag" do
+          it { expect(result[0][:tag].to_snippet_tag).to eq "// @snippet <path/to/file1.c>" }
+          it { expect(result[1][:tag].to_snippet_tag).to eq "// @snippet <path/to/file2.c>"}
+        end
+
+      end
+
+    end # multi snip tags
+
+    context "@snip tags with repository" do
+
+      let(:input_text) do
+        [
+          '# use repository',
+          '# @snip <repo-a:path/to/file1.rb>',
+          '# @snip  <repo-b:path/to/file1.rb>',
+          '# @snip   <repo-b:/path/to/file2.rb>',
+          '# @snippet <path/to/file3.rb>',
+          '',
+          'puts "hello"',
+        ].join($/)
+      end
+
+      context "result" do
+
+        let(:result) { SocialSnippet::TagParser.find_snip_tags(input_text) }
+
+        it "has three elements" do
+          expect(result.length).to eq 3
+        end
+
+        context "line_no" do
+          it { expect(result[0][:line_no]).to eq 1 }
+          it { expect(result[1][:line_no]).to eq 2 }
+          it { expect(result[2][:line_no]).to eq 3 }
+        end
+
+        context "tag.to_snippet_tag" do
+          it { expect(result[0][:tag].to_snippet_tag).to eq "# @snippet <repo-a:path/to/file1.rb>" }
+          it { expect(result[1][:tag].to_snippet_tag).to eq "# @snippet  <repo-b:path/to/file1.rb>" }
+          it { expect(result[2][:tag].to_snippet_tag).to eq "# @snippet   <repo-b:path/to/file2.rb>" }
+        end
+
+      end
+
+    end
+
+  end # find_snip_tags
+
+  describe "#find_snippet_tags" do
+
+    context "@snip tags with repository" do
+
+      let(:input_text) do
+        [
+          '# use repository',
+          '# @snip <repo-a:path/to/file1.rb>',
+          '# @snip  <repo-b:path/to/file1.rb>',
+          '# @snip   <repo-b:/path/to/file2.rb>',
+          '# @snippet <path/to/file3.rb>',
+          '',
+          'puts "hello"',
+        ].join($/)
+      end
+
+      context "result" do
+
+        let(:result) { SocialSnippet::TagParser.find_snippet_tags(input_text) }
+
+        it "has one element" do
+          expect(result.length).to eq 1
+        end
+
+        context "line_no" do
+          it { expect(result[0][:line_no]).to eq 4 }
+        end
+
+        context "tag.to_snip_tag" do
+          it { expect(result[0][:tag].to_snip_tag).to eq "# @snip <path/to/file3.rb>" }
+        end
+
+      end
+
+    end # snip tags with repository
+
+  end # find_snippet_tags
+
+end # SocialSnippet::TagParser
+

data/spec/lib/tag_spec.rb

@@ -0,0 +1,93 @@
+require "spec_helper"
+
+describe SocialSnippet::Tag do
+
+  describe ".new" do
+
+    context "// @snip <path/to/file.cxx>" do
+
+      let(:instance) { SocialSnippet::Tag.new("// @snip <path/to/file.cxx>") }
+
+      context "to_snippet_tag" do
+        subject { instance.to_snippet_tag }
+        it { should eq "// @snippet <path/to/file.cxx>" }
+      end
+
+    end # snip <path/to/file.cxx>
+
+    context "/* @snip <path/to/file.c> */" do
+
+      let(:instance) { SocialSnippet::Tag.new("/* @snip <path/to/file.c> */") }
+
+      context "to_snippet_tag" do
+        subject { instance.to_snippet_tag }
+        it { should eq "/* @snippet <path/to/file.c> */" }
+      end
+
+    end # snip <path/to/file.c>
+
+    context "# @snippet          <many/spaces.py>" do
+
+      let(:instance) { SocialSnippet::Tag.new("# @snippet          <many/space.py>") }
+
+      context "to_snip_tag" do
+        subject { instance.to_snip_tag }
+        it { should eq "# @snip          <many/space.py>" }
+      end
+
+    end # snippet <many/spaces.py>
+
+    context "// @snip <repo:use/repo.cpp>" do
+
+      let(:instance) { SocialSnippet::Tag.new("// @snip <repo:use/repo.cpp>") }
+
+      context "to_snippet_tag" do
+        subject { instance.to_snippet_tag }
+        it { should eq "// @snippet <repo:use/repo.cpp>" }
+      end
+ 
+    end # snip <repo:use/repo.cpp>
+
+    context '// @snip <repo#ref:use/repo/and/version.cpp' do
+
+      let(:instance) { SocialSnippet::Tag.new('// @snip <repo#ref:use/repo/and/version.cpp>') }
+      it { expect(instance.repo).to eq "repo" }
+      it { expect(instance.ref).to eq "ref" }
+
+      context "to_snippet_tag" do
+        subject { instance.to_snippet_tag }
+        it { should eq "// @snippet <repo#ref:use/repo/and/version.cpp>" }
+      end
+
+    end # snip <repo#ref:use/repo/and/version.cpp
+
+    context '# @snip <repo#ref:use/repo/and/version.rb' do
+
+      let(:instance) { SocialSnippet::Tag.new('# @snip <repo#ref:use/repo/and/version.rb>') }
+      it { expect(instance.repo).to eq "repo" }
+      it { expect(instance.ref).to eq "ref" }
+
+      context "to_snippet_tag" do
+        subject { instance.to_snippet_tag }
+        it { should eq "# @snippet <repo#ref:use/repo/and/version.rb>" }
+      end
+
+    end # snip <repo#ref:use/repo/and/version.rb
+
+    context '# @snip <repo#ref:use/repo/and/version.rb #' do
+
+      let(:instance) { SocialSnippet::Tag.new('# @snip <repo#ref:use/repo/and/version.rb> #') }
+      it { expect(instance.repo).to eq "repo" }
+      it { expect(instance.ref).to eq "ref" }
+
+      context "to_snippet_tag" do
+        subject { instance.to_snippet_tag }
+        it { should eq "# @snippet <repo#ref:use/repo/and/version.rb> #" }
+      end
+
+    end # snip <repo#ref:use/repo/and/version.rb
+
+  end # .new
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,106 @@
+require "bundler/setup"
+require_relative "helpers/codeclimate_helper"
+require_relative "helpers/webmock_helper"
+
+require "social_snippet"
+require "json"
+require "cgi"
+require "stringio"
+
+require_relative "helpers/fakefs_helper"
+
+module SocialSnippet::SpecHelpers
+
+  class Fake; end
+
+  def fake_io
+    @fake_io ||= StringIO.new
+  end
+
+  def fake_logger
+    reset_fake_logger unless @logger
+    @logger
+  end
+
+  def reset_fake_logger
+    @logger = ::SocialSnippet::Logger.new(fake_io)
+    @logger.level = ::SocialSnippet::Logger::Severity::INFO
+  end
+
+  def fake_home
+    reset_fake_home unless @tmp_path
+    @tmp_path
+  end
+
+  def reset_fake_home
+    tmp_root = File.join(Dir.tmpdir, "social_snippet")
+    FileUtils.mkdir_p tmp_root
+    @tmp_path = Dir.mktmpdir(nil, tmp_root)
+  end
+
+  def make_fake_home
+    fake_config.init_directories
+  end
+
+  def global_config
+    $social_snippet_config ||= ::SocialSnippet::Config.new(
+      fake_social_snippet,
+      {
+        :home => fake_home,
+        :sspm_host => "api.server",
+      },
+    )
+  end
+
+  def enable_global_config
+    @enable_global_config = true
+  end
+
+  def fake_config
+    @config ||= ::SocialSnippet::Config.new(
+      fake_social_snippet,
+      {
+        :home => fake_home,
+        :sspm_host => "api.server",
+      },
+    )
+  end
+
+  def fake_api
+    @fake_api ||= ::SocialSnippet::Api.new(fake_social_snippet)
+  end
+
+  def fake_social_snippet
+    reset_fake_social_snippet unless @fake_social_snippet
+    @fake_social_snippet
+  end
+
+  def reset_fake_social_snippet
+    @fake_social_snippet = Fake.new
+    allow(fake_social_snippet).to receive(:logger).and_return fake_logger
+    allow(fake_social_snippet).to receive(:config).and_return fake_config
+    allow(fake_social_snippet).to receive(:api).and_return fake_api
+    allow(fake_social_snippet).to receive(:repo_manager).and_return ::SocialSnippet::Repository::RepositoryManager.new(fake_social_snippet)
+    allow(fake_social_snippet).to receive(:registry_client).and_return ::SocialSnippet::Registry::RegistryClient.new(fake_social_snippet)
+    allow_any_instance_of(::SocialSnippet::CommandLine::Command).to receive(:social_snippet).and_return fake_social_snippet
+  end
+
+end
+
+module SocialSnippet
+  ::RSpec.configure do |config|
+    config.include FakeFSHelpers
+    config.before { enable_fakefs }
+    config.after { disable_fakefs }
+
+    config.include SpecHelpers
+    config.before { reset_fake_social_snippet }
+
+    config.before(:example, :without_fakefs => true) do
+      disable_fakefs
+      make_fake_home
+    end
+  end
+end
+
+$WITHOUT_FAKEFS = (ENV["RSPEC_WITHOUT_FAKEFS"] === "true")

data/test/base_repository_test.rb

@@ -0,0 +1,375 @@
+require "spec_helper"
+
+module SocialSnippet::Repository::Drivers
+
+  describe BaseRepository do
+
+    describe "version" do
+
+      context "new path/to/repo" do
+
+        let(:repo) { BaseRepository.new('/path/to/repo') }
+
+        context "version only cases" do
+
+          context "has 0.0.1" do
+
+            before do
+              allow(repo).to receive(:refs).and_return([
+                '0.0.1',
+              ])
+            end
+
+            describe "versions" do
+              let(:result) { repo.versions }
+              it { expect(result.length).to eq 1 }
+              it { expect(result).to include '0.0.1' }
+            end # versions
+
+            describe "latest_version" do
+              it { expect(repo.latest_version).to eq '0.0.1' }
+              it { expect(repo.latest_version('0')).to eq '0.0.1' }
+              it { expect(repo.latest_version('0.0')).to eq '0.0.1' }
+              it { expect(repo.latest_version('0.0.1')).to eq '0.0.1' }
+              it { expect(repo.latest_version('1.0')).to be_nil }
+            end # latest_version
+
+          end # has 0.0.1
+
+          context "has 0.0.1, 0.0.2, 0.0.3, 1.0.0" do
+            
+            before do
+              allow(repo).to receive(:refs).and_return([
+                '0.0.1',
+                '0.0.2',
+                '0.0.3',
+                '1.0.0',
+              ])
+            end
+
+            describe "versions" do
+
+              let(:result) { repo.versions }
+
+              it { expect(result.length).to eq 4 }
+
+              context "check result" do
+                subject { result }
+                it { should include '0.0.1' }
+                it { should include '0.0.2' }
+                it { should include '0.0.3' }
+                it { should include '1.0.0' }
+              end
+
+            end # versions
+
+            describe "latest_version" do
+              it { expect(repo.latest_version).to eq '1.0.0' }
+              it { expect(repo.latest_version('0')).to eq '0.0.3' }
+              it { expect(repo.latest_version('0.0')).to eq '0.0.3' }
+              it { expect(repo.latest_version('1')).to eq '1.0.0' }
+              it { expect(repo.latest_version('0.1')).to be_nil }
+            end # latest_version
+
+          end # has 0.0.1, 0.0.2, 0.0.3, 1.0.0
+
+          context "has 1.2.3, 100.2.300, 123.456.789" do
+            
+            before do
+              allow(repo).to receive(:refs).and_return([
+                '1.2.3',
+                '100.2.300',
+                '123.456.789',
+              ])
+            end
+
+            describe "versions" do
+
+              let(:result) { repo.versions }
+
+              it { expect(result.length).to eq 3 }
+
+              context "check result" do
+                subject { result }
+                it { should include '1.2.3' }
+                it { should include '100.2.300' }
+                it { should include '123.456.789' }
+              end
+
+            end # versions
+
+            describe "latest_version" do
+              it { expect(repo.latest_version).to eq '123.456.789' }
+              it { expect(repo.latest_version('0')).to be_nil }
+              it { expect(repo.latest_version('0.0')).to be_nil }
+              it { expect(repo.latest_version('1')).to eq '1.2.3' }
+              it { expect(repo.latest_version('100')).to eq '100.2.300' }
+              it { expect(repo.latest_version('100.2')).to eq '100.2.300' }
+              it { expect(repo.latest_version('123')).to eq '123.456.789' }
+              it { expect(repo.latest_version('123.456')).to eq '123.456.789' }
+            end # latest_version
+
+          end # has 1.2.3, 100.2.300, 123.456.789
+
+        end # version only cases
+
+        context "include not version cases" do
+
+          context "has master, develop, 0.0.1, 0.1.0, 1.0.0" do
+
+            before do
+              allow(repo).to receive(:refs).and_return([
+                'master',
+                'develop',
+                '0.0.1',
+                '0.1.0',
+                '1.0.0',
+              ])
+            end
+
+            describe "versions" do
+              let(:result) { repo.versions }
+
+              it { expect(result.length).to eq 3 }
+
+              context "check result" do
+                subject { result }
+                it { should include '0.0.1' }
+                it { should include '0.1.0' }
+                it { should include '1.0.0' }
+              end
+            end # versions
+
+            describe "latest_version" do
+              it { expect(repo.latest_version).to eq '1.0.0' }
+              it { expect(repo.latest_version('0')).to eq '0.1.0' }
+              it { expect(repo.latest_version('0.0')).to eq '0.0.1' }
+              it { expect(repo.latest_version('1')).to eq '1.0.0' }
+              it { expect(repo.latest_version('100')).to be_nil }
+              it { expect(repo.latest_version('100.2')).to be_nil }
+              it { expect(repo.latest_version('123')).to be_nil}
+              it { expect(repo.latest_version('123.456')).to be_nil }
+              it { expect(repo.latest_version('master')).to be_nil }
+              it { expect(repo.latest_version('develop')).to be_nil }
+            end # latest_version
+
+          end # has master, develop, 0.0.1, 0.1.0, 1.0.0
+
+          context "has master, feature/0.0.1, 0.0.1/test, 001, 0.0, 1, 1.2.3" do
+
+            before do
+              allow(repo).to receive(:refs).and_return([
+                'master',
+                'feature/0.0.1',
+                '0.0.1/test',
+                '001',
+                '0.0',
+                '1',
+                '1.2.3',
+              ])
+            end
+
+            describe "versions" do
+
+              let(:result) { repo.versions }
+
+              it { expect(result.length).to eq 1 }
+              it { expect(result).to include '1.2.3' }
+
+            end # versions
+
+            describe "latest_version" do
+              it { expect(repo.latest_version).to eq '1.2.3' }
+              it { expect(repo.latest_version('0')).to be_nil }
+              it { expect(repo.latest_version('0.0')).to be_nil }
+              it { expect(repo.latest_version('1')).to eq '1.2.3' }
+              it { expect(repo.latest_version('100')).to be_nil }
+              it { expect(repo.latest_version('100.2')).to be_nil }
+              it { expect(repo.latest_version('123')).to be_nil}
+              it { expect(repo.latest_version('123.456')).to be_nil }
+              it { expect(repo.latest_version('master')).to be_nil }
+              it { expect(repo.latest_version('develop')).to be_nil }
+            end # latest_version
+
+          end # has master, feature/0.0.1, 0.0.1/test, 001, 0.0, 1, 1.2.3
+
+        end # include not version cases
+
+      end # new path/to/repo
+
+    end # versions
+
+    describe "cache test" do
+
+      let(:commit_id) { "thisisdummyyyyy" }
+
+      context "there is a repo" do
+
+        before do
+          FileUtils.mkdir_p "/path/to/repo_1"
+          FileUtils.mkdir_p "/path/to/repo_1/.git"
+          FileUtils.touch "/path/to/repo_1/snippet.json"
+
+          File.write "/path/to/repo_1/snippet.json", [
+            '{',
+            '  "name": "repo_1",',
+            '  "desc": "this is repo_1",',
+            '  "language": "Ruby"',
+            '}',
+          ].join("\n")
+        end
+
+        context "create repo_1 instance" do
+
+          let(:cache_path) { "/path/to/cache" }
+          before { FileUtils.mkdir_p(cache_path) }
+
+          let(:instance) do
+            repo = BaseRepository.new("/path/to/repo_1")
+            repo.load_snippet_json
+            return repo
+          end
+
+          context "name" do
+            subject { instance.name }
+            it { should eq "repo_1" }
+          end
+
+          context "create cache" do
+            before do
+              expect(instance).to receive(:commit_id).and_return commit_id
+              instance.create_cache(cache_path)
+            end
+
+            context "snippet.json" do
+              let(:result) { JSON.parse File.read "#{cache_path}/repo_1/#{commit_id[0..7]}/snippet.json" }
+              it { expect(result["name"]).to eq "repo_1" }
+              it { expect(result["desc"]).to eq "this is repo_1" }
+              it { expect(result["language"]).to eq "Ruby" }
+            end
+
+          end # create cache
+
+        end # create repo_1 instance
+
+      end # there is a repo
+
+      context "there are three repos" do
+
+        before do
+          # create repo_1
+          FileUtils.mkdir_p "/path/to/repo_1"
+          FileUtils.mkdir_p "/path/to/repo_1/.git"
+          FileUtils.touch "/path/to/repo_1/snippet.json"
+          File.write "/path/to/repo_1/snippet.json", [
+            '{',
+            '  "name": "repo_1",',
+            '  "desc": "this is repo_1",',
+            '  "language": "Ruby"',
+            '}',
+          ].join("\n")
+
+          # create repo_b
+          FileUtils.mkdir_p "/path/to/repo_b"
+          FileUtils.mkdir_p "/path/to/repo_b/.git"
+          FileUtils.touch "/path/to/repo_b/snippet.json"
+          File.write "/path/to/repo_b/snippet.json", [
+            '{',
+            '  "name": "repo_b",',
+            '  "desc": "this is repo_b",',
+            '  "language": "Ruby"',
+            '}',
+          ].join("\n")
+
+          # create repo_3
+          FileUtils.mkdir_p "/path/to/repo_3"
+          FileUtils.mkdir_p "/path/to/repo_3/.git"
+          FileUtils.touch "/path/to/repo_3/snippet.json"
+          File.write "/path/to/repo_3/snippet.json", [
+            '{',
+            '  "name": "repo_3",',
+            '  "desc": "this is repo_3",',
+            '  "language": "Ruby"',
+            '}',
+          ].join("\n")
+        end # before 
+
+        context "create three instances" do
+
+          let(:instance_1) { BaseRepository.new("/path/to/repo_1") }
+          let(:instance_b) { BaseRepository.new("/path/to/repo_b") }
+          let(:instance_3) { BaseRepository.new("/path/to/repo_3") }
+
+          before do
+            instance_1.load_snippet_json
+            instance_b.load_snippet_json
+            instance_3.load_snippet_json
+          end
+
+          context "name" do
+            it { expect(instance_1.name).to eq "repo_1" }
+            it { expect(instance_b.name).to eq "repo_b" }
+            it { expect(instance_3.name).to eq "repo_3" }
+          end
+
+          context "create cache" do
+
+            # create cache dir
+            let(:cache_path) { "/path/to/cache" }
+            before { FileUtils.mkdir_p(cache_path) }
+
+            before do
+              expect(instance_1).to receive(:commit_id).and_return commit_id
+              expect(instance_b).to receive(:commit_id).and_return commit_id
+              expect(instance_3).to receive(:commit_id).and_return commit_id
+            end
+
+            before do
+              instance_1.create_cache(cache_path)
+              instance_b.create_cache(cache_path)
+              instance_3.create_cache(cache_path)
+            end
+
+            context "snippet.json" do
+
+              context "repo_1" do
+                let(:result) do
+                  JSON.parse File.read "#{cache_path}/repo_1/#{commit_id[0..7]}/snippet.json"
+                end
+                it { expect(result["name"]).to eq "repo_1" }
+                it { expect(result["desc"]).to eq "this is repo_1" }
+                it { expect(result["language"]).to eq "Ruby" }
+              end
+
+              context "repo_b" do
+                let(:result) do
+                  JSON.parse File.read "#{cache_path}/repo_b/#{commit_id[0..7]}/snippet.json"
+                end
+                it { expect(result["name"]).to eq "repo_b" }
+                it { expect(result["desc"]).to eq "this is repo_b" }
+                it { expect(result["language"]).to eq "Ruby" }
+              end
+
+              context "repo_3" do
+                let(:result) do
+                  JSON.parse File.read "#{cache_path}/repo_3/#{commit_id[0..7]}/snippet.json"
+                end
+                it { expect(result["name"]).to eq "repo_3" }
+                it { expect(result["desc"]).to eq "this is repo_3" }
+                it { expect(result["language"]).to eq "Ruby" }
+              end
+
+            end # snippet.json
+
+          end # create cache
+
+        end # create three instances 
+
+      end # there are three repos
+
+    end # .new
+
+  end # BaseRepository
+
+end # SocialSnippet::Repository
+