social_snippet 0.0.6 → 0.0.7

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NDExZWFlYjUyMzUyOGQwYWFkNjg0YjRhZDg0ZDdmMzA1MTViMjIxMA==
+    NzU5NTJjOWRhNjY0MGQ1Yjk2MzY0YjA3ZmU3YTc3NzkzYjBjYWM4Mg==
   data.tar.gz: !binary |-
-    OGMyMTAyZjdmODQ2NzJiNzM4YzAyMGJlZDRmMjQwZjEyYmIxMmJiZQ==
+    ZWIxMDM3ODY5MTgxYzEyMGU0ZWM4ZWNjNWFjZWJkMjg5ODgyYWQ5OA==
 SHA512:
   metadata.gz: !binary |-
-    MTg1MWU1OGM5ODUxMjdhNTZlZDhhMmU5ZTMzYmM2N2ExMWNjNDNmYjM2MmM2
-    MTE2MzU0NzYyNGU4NWU1NDljNmRjNzE5MTI5NmQ3Njc2Y2NhZGRlNzNiNThj
-    YzRmNTA0ZDVhYmVlNmI4ZGZjMWI0MjNmYzE1ZjVhNjk0ZThmMWQ=
+    ZDlhNWY2ZDMyOWZhNzRiNGQ2NzUxZGNkOWUyNGNlNGE5ZmE1MDBiZTBkMGVj
+    ZGU0ZjViN2MxMDU0ZjlhYmZkZDcwYTI1MzYyYWVkMTUwMDM5NDJjMjA3ODlj
+    MTk0ZGYyOTVkNWQ4Yjk4OGZhMzFmOWQxNmVjMzhkN2NlMTY2Y2U=
   data.tar.gz: !binary |-
-    YjY0NjczODE3NWUxZjRhNGFmMzliY2IyYTFmODJjM2I3OGU5MTJjZmVjNGUz
-    NTY4MTE1Y2ZlN2FlMGU1ZmNjMTZlMjc2ZGJkNGFjNjAyM2M3MjZkN2JjZGZm
-    MmY3MmFhYWM4ZGExNjA0YWZlYjI4ZDU0MDI0MGI1MDRjNGFlNjQ=
+    YTJiY2ZjZWFjYWFkNTZmNGIxMzA4Yjk1Mzc0NzgwNWRhZjFiMjM5OTFhZGZm
+    Mzk3NTg0NmUwZTY2MzIwYjI0NzI3MzZkNTE5MjkwOGFlNDI4MzUzYjdjNDMw
+    ODNlNjkzMTdkODU4ZTc3NzNkNTUyOTk1YmNiMWQzZmI0MjY0Mjg=

data/lib/social_snippet/api/insert_snippet_api.rb

@@ -6,6 +6,7 @@ module SocialSnippet::Api::InsertSnippetApi
   # @param src [String] The text of source code
   #
   def insert_snippet(src, options = {})
+    raise "must be passed string" unless src.is_a?(String)
     resolver = ::SocialSnippet::Resolvers::InsertResolver.new(social_snippet, options)
     res = resolver.insert(src)
     output res

data/lib/social_snippet/repository/repository_manager.rb

@@ -39,7 +39,7 @@ module SocialSnippet::Repository
       not deps(repo_name, repo_ref).empty?
     end
 
-    # Get snippet
+    # Get snippet by context and tag
     #
     # @param context [::SocialSnippet::Context] The context of snippet
     # @param tag [::SocialSnippet::Tag] The tag of snippet

data/lib/social_snippet/resolvers/base_resolver.rb

@@ -15,11 +15,13 @@ module SocialSnippet
 
     # Call block each snip tags
     #
-    # @param src [Array<String>] The text of source code
-    # @param context [SocialSnippet::Context] The context of current code
-    # @param base_tag [SocialSnippet::Tag]
-    def each_snip_tags(src, context, base_tag)
-      TagParser.find_snip_tags(src).each do |tag_info|
+    # @param snippet [Snippet]
+    # @param context [Context] The context of current code
+    # @param base_tag [Tag]
+    def each_child_snippet(snippet, context, base_tag)
+      raise "must be passed snippet" unless snippet.is_a?(Snippet)
+
+      snippet.snip_tags.each do |tag_info|
         t = tag_info[:tag].set_by_tag(base_tag)
         new_context = context.clone
 
@@ -28,42 +30,16 @@ module SocialSnippet
         update_tag_path_by_context! new_context, t
         resolve_tag_repo_ref! t
 
-        snippet = social_snippet.repo_manager.get_snippet(context, t)
+        child_snippet = social_snippet.repo_manager.get_snippet(context, t)
 
         if block_given?
-          yield(
-            tag_info[:tag],
-            tag_info[:line_no],
-            snippet,
-            new_context
-          )
+          yield tag_info[:tag], tag_info[:line_no], child_snippet, new_context
         end
       end
     end
 
-    # @param lines [Array<String>]
-    def filter(lines)
-      lines = cut_filter(lines)
-      lines
-    end
-
     private
 
-    def cut_filter(lines)
-      cut_level = 0
-      lines.select do |line|
-        if Tag.is_begin_cut?(line)
-          cut_level += 1
-          false
-        elsif Tag.is_end_cut?(line)
-          cut_level -= 1
-          false
-        else
-          cut_level === 0
-        end
-      end
-    end
-
     def move_context_by_tag!(context, tag)
       if tag.has_repo?
         if tag.has_ref?

data/lib/social_snippet/resolvers/dep_resolver.rb

@@ -14,11 +14,13 @@ module SocialSnippet
 
     # Find all missing depended snippets
     #
-    # @param src [Array<String>] The text of source code
+    # @param snippet [Snippet] The text of source code
     # @param context_from [SocialSnippet::Context] The context of previous code
     # @param tag_from [SocialSnippet::Tag] The previous tag
-    def find(src, context_from, tag_from)
-      found_tags = find_func src, context_from, tag_from
+    def find(snippet, context_from, tag_from)
+      raise "must be passed snippet" unless snippet.is_a?(Snippet)
+
+      found_tags = find_func snippet, context_from, tag_from
       found_tags.each do |tag_info|
         # remove self from deps graph
         tag = tag_info[:tag]
@@ -35,11 +37,13 @@ module SocialSnippet
       dep_to[tag_from.to_path].add tag_to.to_path
     end
 
-    def find_func(src, context_from, tag_from)
+    def find_func(snippet, context_from, tag_from)
+      raise "must be passed snippet" unless snippet.is_a?(Snippet)
+
       found_tags = []
       context = context_from.clone
 
-      each_snip_tags(src, context_from, tag_from) do |tag, line_no, snippet, new_context|
+      each_child_snippet(snippet, context_from, tag_from) do |tag, line_no, child_snippet, new_context|
         next if is_visited(tag)
         visit tag
 
@@ -48,13 +52,7 @@ module SocialSnippet
           :tag => tag,
           :context => new_context,
         })
-        # find more deps
-        if snippet.is_a?(Snippet)
-          snippet_lines = snippet.lines
-        else
-          snippet_lines = snippet.split($/)
-        end
-        found_tags.push *find_func(snippet_lines, new_context, tag)
+        found_tags.push *find_func(child_snippet, new_context, tag)
       end
 
       return found_tags

data/lib/social_snippet/resolvers/insert_resolver.rb

@@ -22,35 +22,39 @@ module SocialSnippet
 
     # Insert snippets to given text
     #
-    # @param src [Array<String>] The text of source code
-    def insert(src)
+    # @param text [String] The text of source code
+    def insert(text)
+      raise "must be passed string" unless text.is_a?(String)
+
       context = Context.new("")
-      lines = filter(src.split $/)
+      snippet = Snippet.new_text(text)
 
-      TagParser.find_snippet_tags(lines).each do |tag_info|
+      snippet.snippet_tags.each do |tag_info|
         visit tag_info[:tag]
       end
 
-      dest = insert_func(lines, context)
+      dest = insert_func(snippet, context)
       return dest.join($/)
     end
 
     private
 
-    def insert_func(code, context_from, base_tag = nil)
-      inserter = Inserter.new(code)
+    def insert_func(snippet, context_from, base_tag = nil)
+      raise "must be passed snippet" unless snippet.is_a?(Snippet)
+
+      inserter = Inserter.new(snippet.lines)
       context = context_from.clone
 
       # replace each @snip tags
-      each_snip_tags(code, context, base_tag) do |tag, line_no, snippet, new_context|
+      each_child_snippet(snippet, context, base_tag) do |tag, line_no, child_snippet, new_context|
         inserter.set_index line_no
         inserter.ignore
 
         visit(tag) if is_self(tag, context)
         next if is_visited(tag)
 
-        insert_depended_snippets! inserter, snippet, new_context, tag
-        insert_by_tag_and_context! inserter, snippet, new_context, tag
+        insert_depended_snippets! inserter, child_snippet, new_context, tag
+        insert_by_tag_and_context! inserter, child_snippet, new_context, tag
       end
 
       inserter.set_index_last
@@ -58,12 +62,10 @@ module SocialSnippet
     end
 
     # Insert snippet by tag and context
-    def insert_by_tag_and_context!(inserter, snippet_str, context, tag)
-      if snippet_str.is_a?(Snippet)
-        src = insert_func(snippet_str.lines, context, tag)
-      else
-        src = insert_func(snippet_str.split($/), context, tag)
-      end
+    def insert_by_tag_and_context!(inserter, snippet, context, tag)
+      raise "must be passed snippet" unless snippet.is_a?(Snippet)
+
+      src = insert_func(snippet, context, tag)
 
       options[:margin_top].times { inserter.insert "" }
       inserter.insert tag.to_snippet_tag # @snip -> @snippet
@@ -75,7 +77,9 @@ module SocialSnippet
 
     # Insert depended snippet
     def insert_depended_snippets!(inserter, snippet, context, tag)
-      dep_tags = deps_resolver.find(snippet.lines, context, tag)
+      raise "must be passed snippet" unless snippet.is_a?(Snippet)
+
+      dep_tags = deps_resolver.find(snippet, context, tag)
       dep_tags = sort_dep_tags_by_dep(dep_tags)
 
       dep_tags.each do |tag_info|
@@ -85,8 +89,8 @@ module SocialSnippet
         visit(tag) if is_self(tag, context)
         next if is_visited(sub_t)
 
-        sub_snippet = social_snippet.repo_manager.get_snippet(sub_c, sub_t)
-        insert_by_tag_and_context! inserter, sub_snippet, sub_c, sub_t
+        next_snippet = social_snippet.repo_manager.get_snippet(sub_c, sub_t)
+        insert_by_tag_and_context! inserter, next_snippet, sub_c, sub_t
       end
     end
 

data/lib/social_snippet/snippet.rb

@@ -1,14 +1,75 @@
 class SocialSnippet::Snippet
 
-  attr_reader :path
+  attr_reader :filepath
   attr_reader :code
-  attr_reader :lines
 
   # Constructor
   def initialize(snippet_path)
-    @path = snippet_path
-    @code = ::File.read(path)
-    @lines = code.split($/)
+    @filepath = snippet_path
+    read_file unless filepath.nil?
+  end
+
+  def read_file
+    @code = ::File.read(filepath).split($/)
+  end
+
+  def read_text(s)
+    raise "must be passed string" unless s.is_a?(String)
+    @code = s.split($/)
+  end
+
+  def lines
+    @lines ||= new_lines
+  end
+
+  def snippet_tags
+    ::SocialSnippet::TagParser.find_snippet_tags lines
+  end
+
+  def snip_tags
+    ::SocialSnippet::TagParser.find_snip_tags lines
+  end
+
+  class << self
+
+    # Create instance by text
+    def new_text(s)
+      raise "must be passed string" unless s.is_a?(String)
+      snippet = self.new(nil)
+      snippet.read_text s
+      snippet
+    end
+
+  end
+
+  private
+
+  # Return filtered and styled lines
+  def new_lines
+    tmp = code.clone
+    tmp = filter(tmp)
+    tmp
+  end
+
+  # @param lines [Array<String>]
+  def filter(lines)
+    lines = cut_filter(lines)
+    lines
+  end
+
+  def cut_filter(lines)
+    cut_level = 0
+    lines.select do |line|
+      if ::SocialSnippet::Tag.is_begin_cut?(line)
+        cut_level += 1
+        false
+      elsif ::SocialSnippet::Tag.is_end_cut?(line)
+        cut_level -= 1
+        false
+      else
+        cut_level === 0
+      end
+    end
   end
 
 end

data/lib/social_snippet/version.rb

@@ -1,6 +1,6 @@
 module SocialSnippet
 
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 
   module Version
 

data/social_snippet.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = SocialSnippet::VERSION
   spec.authors       = ["Hiroyuki Sano"]
   spec.email         = ["sh19910711@gmail.com"]
-  spec.summary       = %q{Share and use snippet libraries for the online judges}
+  spec.summary       = %q{A snippet manager to share and use snippet library for the online judges; Google Code Jam, Codeforces, ACM/ICPC and etc...}
   spec.homepage      = "https://github.com/social-snippet/social-snippet"
   spec.license       = "MIT"
 

data/spec/lib/insert_resolver_spec.rb

@@ -9,7 +9,7 @@ describe SocialSnippet::Resolvers::InsertResolver do
         t.repo
       end
       allow(fake_social_snippet.repo_manager).to receive(:get_snippet) do |c, t|
-        t.repo
+        ::SocialSnippet::Snippet.new_text(t.repo)
       end
     end
 
@@ -19,11 +19,11 @@ describe SocialSnippet::Resolvers::InsertResolver do
 
         before do
           allow(fake_social_snippet.repo_manager).to receive(:get_snippet) do |c, t|
-            [
+            ::SocialSnippet::Snippet.new_text([
               "def foo",
               "  42",
               "end",
-            ].join($/)
+            ].join $/)
           end
         end # prepare snippet
 

data/test/core_test.rb

@@ -2086,6 +2086,85 @@ describe SocialSnippet::Core do
 
     end # more duplicate cases
 
+    context "filters" do
+
+      context "range cut (simple)" do
+
+        before do
+          FileUtils.touch "./file1.cpp"
+          File.write "./file1.cpp", [
+            "// @begin_cut",
+            "#include <path/to/lib>",
+            "// @end_cut",
+            "void func() {",
+            "}",
+          ].join($/)
+        end
+
+        let(:input) do
+          [
+            "// @snip <./file1.cpp>",
+          ].join($/)
+        end
+
+        let(:output) do
+          [
+            "// @snippet <file1.cpp>",
+            "void func() {",
+            "}",
+          ].join($/)
+        end
+
+        subject { fake_social_snippet.api.insert_snippet(input) }
+        it { should eq output }
+
+      end
+
+      context "range cut (nested snippet)" do
+
+        before do
+          FileUtils.touch "./file1.cpp"
+          File.write "./file1.cpp", [
+            "// @begin_cut",
+            "#include <path/to/lib>",
+            "// @end_cut",
+            "// @snip <./file2.cpp>",
+            "void func1() {",
+            "}",
+          ].join($/)
+          File.write "./file2.cpp", [
+            "// @begin_cut",
+            "#include <path/to/lib>",
+            "// @end_cut",
+            "void func2() {",
+            "}",
+          ].join($/)
+        end
+
+        let(:input) do
+          [
+            "// @snip <./file1.cpp>",
+          ].join($/)
+        end
+
+        let(:output) do
+          [
+            "// @snippet <file2.cpp>",
+            "void func2() {",
+            "}",
+            "// @snippet <file1.cpp>",
+            "void func1() {",
+            "}",
+          ].join($/)
+        end
+
+        subject { fake_social_snippet.api.insert_snippet(input) }
+        it { should eq output }
+
+      end
+
+    end # filters
+
   end # insert_snippet
 
 end # SocialSnippet::Core

data/test/{base_resolver_test.rb → snippet_test.rb}

@@ -1,10 +1,8 @@
 require "spec_helper"
 
-module SocialSnippet::Resolvers
+module SocialSnippet
 
-  describe BaseResolver do
-
-    let(:resolver) { BaseResolver.new(fake_social_snippet) }
+  describe Snippet do
 
     describe "#filter()" do
 
@@ -31,13 +29,16 @@ module SocialSnippet::Resolvers
           ]
         end
 
-        subject { resolver.filter(input) }
+        let(:snippet) { Snippet.new nil }
+        before { snippet.read_text input.join($/) }
+        subject { snippet.lines }
         it { should eq expected }
 
       end
 
     end
 
-  end # BaseResolver
+  end # Snippet
+
+end # SocialSnippet
 
-end # SocialSnippet::Resolvers

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: social_snippet
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Hiroyuki Sano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-27 00:00:00.000000000 Z
+date: 2015-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: version_sorter
@@ -295,7 +295,6 @@ files:
 - spec/lib/tag_spec.rb
 - spec/spec_helper.rb
 - test/base_repository_test.rb
-- test/base_resolver_test.rb
 - test/command_test.rb
 - test/config_test.rb
 - test/context_test.rb
@@ -303,6 +302,7 @@ files:
 - test/git_repository_test.rb
 - test/install_command_test.rb
 - test/repository_manager_test.rb
+- test/snippet_test.rb
 - test/tag_parser_test.rb
 - test/tag_test.rb
 - test/version_test.rb
@@ -329,7 +329,8 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Share and use snippet libraries for the online judges
+summary: A snippet manager to share and use snippet library for the online judges;
+  Google Code Jam, Codeforces, ACM/ICPC and etc...
 test_files:
 - spec/helpers/codeclimate_helper.rb
 - spec/helpers/fakefs_helper.rb
@@ -355,7 +356,6 @@ test_files:
 - spec/lib/tag_spec.rb
 - spec/spec_helper.rb
 - test/base_repository_test.rb
-- test/base_resolver_test.rb
 - test/command_test.rb
 - test/config_test.rb
 - test/context_test.rb
@@ -363,6 +363,7 @@ test_files:
 - test/git_repository_test.rb
 - test/install_command_test.rb
 - test/repository_manager_test.rb
+- test/snippet_test.rb
 - test/tag_parser_test.rb
 - test/tag_test.rb
 - test/version_test.rb