social_snippet 0.0.4 → 0.0.5

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MDgwZmJhNmU0MDJmMjExOTVjZTM3ZmI4Y2EyMDNjN2ZmOWQ2MzI5Yg==
+    ZjdkNTQyNTZmNWMzYmFmOWM0MGU1NDhjOTRlNjIxMGNmNGNkYTU5YQ==
   data.tar.gz: !binary |-
-    ZGQ5Mjk5MzFiZmM0ZWM1OTJmMjdlNjMyMTcyNmQxNmRmZWM0NTE1Yg==
+    YjQ3MDAwNWI3MDliOWFjNjY0YjA3MTdmODYyNmQ1MDk0NjEzNGY2NA==
 SHA512:
   metadata.gz: !binary |-
-    NmUzZjQ0MWEwZWE0ZmYxNDlhMDJlYWY0NDhjNjA4NzdmZTUzY2FhYjA3MWMz
-    MGRiNzdhNTNkZjZiZWRjZTlkYTM4OWYwODQ2ZWIzYTg3NTNiNTI3NTYxNmUw
-    Y2I1ZTIwMWRjYzRmOGRkOTYzN2IyNmI4MGRlNzZmNzdiNzVmYmQ=
+    YTQxZGJmOGQwNDYzNjUwN2E3ZjM5ODI4NWFlNDMxNDFkZTJlYzBhMzkzZjkw
+    MzE3NzBjMzk3MjYxMTgyZGQxMTRjMzFlN2Y1MjFhMjMyMTI0MmU4Yjg1NDJj
+    YjY4NWYzZjY0NDM3NzE5YjViMmExNjY3YTg4MTI2ZmRkZjVkZjQ=
   data.tar.gz: !binary |-
-    OWQyMTk2NTAxMzRhODYyYWViZTY5OTBhMjkyNzU0NjNhNTIzOGQyYzJiOGZj
-    ZTFhM2EwMTA1NjJkZjA0MGRhZWE4Yjk5YWYxOTRkNjVkOTgwM2VjZWZmNGVm
-    OTZlZDMxYzk1MDEwODYzZDUxNmMzNzA1YjM2YzU4ZTE3MDJiNDM=
+    ZWMwZjM4NGQ2MWIwMmYzOGNjMTQ5NzVjNTNlZjg4NWUyNDJkMmEyYzEyMmIy
+    NzE5M2FhOTkwNDFiODU3YTNlMmQ3NDBiNmRmMzMxZWIzYTNkODFkYTkzMDdj
+    MTU4ZjRmNjAzZDc1OTY3MmViMmIxYTA5ZGRhZTQ5NWRlYmU2NGU=

data/.travis.yml

@@ -23,6 +23,9 @@ deploy:
       secure: "hlC3/Vsqpw3RdA0g8nAuusXEpGiwLtndGQVd8eg8x7yCoubFmsruwJG2Cci4QF2aIVGovFzrrmlxPb204nndsmBCzTLZEnn2dsCqOt8TZDAyFRZf6xeZ53eT7AjOJvFIafS4YLQ975upzsQ/cW4OgWFRaqhHgckTUSapa7Dyeao="
   gem:
     master: social_snippet
+  on:
+    repo: social-snippet/social-snippet
+    ruby: "2.2"
 
 cache:
   bundler: true

data/Gemfile

@@ -1,27 +1,2 @@
 source 'https://rubygems.org'
-
-gem "bundler"
-gem "rake"
-gem "version_sorter"
-gem "rugged"
-gem "rest-client"
-
-group :development do
-  gem "yard", :require => false
-  gem "pry", :require => false
-  gem "guard", :require => false
-  gem "guard-shell", :require => false
-end
-
-group :test do
-  gem "rspec", :require => false
-  gem "fakefs", :require => false
-  gem "webmock", :require => false
-  gem "simplecov", :require => false
-  gem "codeclimate-test-reporter", :require => false
-end
-
-# should be disabled on travis-ci
-group :debug do
-  gem "pry-byebug", :require => false
-end
+gemspec

data/README.md

@@ -4,6 +4,7 @@
 [![Build Status](https://img.shields.io/travis/social-snippet/social-snippet.svg)](https://travis-ci.org/social-snippet/social-snippet)
 [![Code Climate](https://img.shields.io/codeclimate/github/social-snippet/social-snippet.svg)](https://codeclimate.com/github/social-snippet/social-snippet)
 [![Test Coverage](https://img.shields.io/codeclimate/coverage/github/social-snippet/social-snippet.svg)](https://codeclimate.com/github/social-snippet/social-snippet)
+[![API Doc](http://img.shields.io/badge/RubyDocs-API-green.svg)](http://www.rubydoc.info/github/social-snippet/social-snippet)
 
 TODO: Write a gem description
 

data/lib/social_snippet.rb

@@ -14,3 +14,4 @@ require_relative "social_snippet/registry"
 require_relative "social_snippet/command_line"
 require_relative "social_snippet/logger"
 require_relative "social_snippet/api"
+require_relative "social_snippet/tsortable_hash"

data/lib/social_snippet/api.rb

@@ -9,25 +9,55 @@ class SocialSnippet::Api
     @social_snippet = new_social_snippet
   end
 
+  # $ sspm config key=value
   def config_set(key, value)
     social_snippet.config.set! key, value
   end
 
+  # $ sspm config key
   def config_get(key)
     value = social_snippet.config.get(key)
     social_snippet.logger.say "#{key}=#{value}"
   end
 
-  # Insert snippets to given text
+  # Initialize the snippet.json interactively.
+  # $ sspm init
+  def init_manifest(options = {})
+    answer = {}
+    json_str = "{}"
+
+    # load current configuration
+    if ::File.exists?("snippet.json")
+      answer = ::JSON.parse(::File.read "snippet.json")
+    end
+
+    loop do
+      answer = ask_manifest_questions(manifest_questions(answer), answer)
+      json_str = ::JSON.pretty_generate(answer)
+      social_snippet.logger.say ""
+      social_snippet.logger.say json_str
+      social_snippet.logger.say ""
+      break if ask_confirm("Is this okay? [Y/N]: ")
+    end
+
+    ::File.write "snippet.json", json_str
+
+    answer
+  end
+
+  # Insert snippets to given text.
+  # $ ssnip
   #
   # @param src [String] The text of source code
-  def insert_snippet(src)
-    resolver = ::SocialSnippet::Resolvers::InsertResolver.new(social_snippet)
+  #
+  def insert_snippet(src, options = {})
+    resolver = ::SocialSnippet::Resolvers::InsertResolver.new(social_snippet, options)
     res = resolver.insert(src)
     output res
     res
   end
 
+  # $ sspm install name
   def install_repository_by_name(repo_name, repo_ref, options = {})
     installed_as = repo_name
     installed_as = options[:name] unless options[:name].nil?
@@ -51,12 +81,14 @@ class SocialSnippet::Api
     install_repository installed_as, repo_ref, repo
   end
 
+  # $ sspm install URL
   def install_repository_by_url(repo_url, repo_ref, options = {})
     output "Cloning repository..."
     repo = ::SocialSnippet::Repository::RepositoryFactory.clone(repo_url)
     install_repository_by_repo repo, repo_ref, options
   end
 
+  # $ sspm install ./path/to/repo
   def install_repository_by_path(repo_path, repo_ref, options = {})
     output "Cloning repository..."
     repo = ::SocialSnippet::Repository::RepositoryFactory.clone_local(repo_path)
@@ -76,39 +108,8 @@ class SocialSnippet::Api
     install_repository installed_as, repo_ref, repo
   end
 
-  # Install repository
-  #
-  # @param repo [::SocialSnippet::Repository::Drivers::BaseRepository]
-  def install_repository(repo_name, repo_ref, repo, options = {})
-    display_name = repo_name
-
-    if repo_ref.nil?
-      repo_ref = resolve_reference(repo)
-
-      if repo.has_versions?
-        output "Resolving #{display_name}'s version"
-      else
-        output "No versions, use current reference"
-      end
-    end
-
-    display_name = "#{repo_name}\##{repo_ref}"
-
-    output "Installing: #{display_name}"
-    unless options[:dry_run]
-      social_snippet.repo_manager.install repo_name, repo_ref, repo, options
-    end
-
-    output "Success: #{display_name}"
-
-    # install dependencies
-    if has_dependencies?(repo)
-      output "Finding #{display_name}'s dependencies"
-      install_missing_dependencies repo.dependencies, options
-      output "Finish finding #{display_name}'s dependencies"
-    end
-  end
-
+  # Update a repository
+  # $ sspm update repo-name
   def update_repository(repo_name, options = {})
     unless social_snippet.repo_manager.exists?(repo_name)
       output "ERROR: #{repo_name} is not installed"
@@ -150,6 +151,8 @@ class SocialSnippet::Api
     end
   end
 
+  # Update all installed repositories
+  # $ sspm update
   def update_all_repositories(options = {})
     social_snippet.repo_manager.each_installed_repo do |repo_name|
       update_repository repo_name, options
@@ -171,6 +174,7 @@ class SocialSnippet::Api
     output ::JSON.pretty_generate(repo_info)
   end
 
+  # $ sspm search query
   def search_repositories(query, options = {})
     format_text = search_result_format(options)
     social_snippet.registry_client.repositories.search(query).each do |repo|
@@ -189,6 +193,86 @@ class SocialSnippet::Api
 
   private
 
+  # Install repository
+  #
+  # @param repo [::SocialSnippet::Repository::Drivers::BaseRepository]
+  def install_repository(repo_name, repo_ref, repo, options = {})
+    display_name = repo_name
+
+    if repo_ref.nil?
+      repo_ref = resolve_reference(repo)
+
+      if repo.has_versions?
+        output "Resolving #{display_name}'s version"
+      else
+        output "No versions, use current reference"
+      end
+    end
+
+    display_name = "#{repo_name}\##{repo_ref}"
+
+    output "Installing: #{display_name}"
+    unless options[:dry_run]
+      social_snippet.repo_manager.install repo_name, repo_ref, repo, options
+    end
+
+    output "Success: #{display_name}"
+
+    # install dependencies
+    if has_dependencies?(repo)
+      output "Finding #{display_name}'s dependencies"
+      install_missing_dependencies repo.dependencies, options
+      output "Finish finding #{display_name}'s dependencies"
+    end
+  end
+
+  def ask_confirm(message)
+    ret = social_snippet.prompt.ask(message) do |q|
+      q.limit = 1
+      q.validate = /^[yn]$/i
+    end
+    /y/i === ret
+  end
+
+  def ask_manifest_questions(questions, obj)
+    questions.inject(obj) do |obj, q|
+      obj[q[:key]] = ask_manifest_question(q)
+      obj
+    end
+  end
+
+  def ask_manifest_question(question)
+    if question[:type] === :string
+      social_snippet.prompt.ask("#{question[:key]}: ") do |q|
+        q.default = question[:default]
+        if question[:validate].is_a?(Regexp)
+          q.validate = question[:validate]
+        end
+      end
+    end
+  end
+
+  def manifest_questions(answer)
+    [
+      {
+        :key => "name",
+        :type => :string,
+        :validate => /[a-zA-Z0-9\.\-_]+/,
+        :default => answer["name"],
+      },
+      {
+        :key => "description",
+        :type => :string,
+        :default => answer["description"],
+      },
+      {
+        :key => "license",
+        :default => answer["license"] || "MIT",
+        :type => :string,
+      },
+    ]
+  end
+
   def resolve_reference(repo)
     if repo.has_versions?
       repo.latest_version

data/lib/social_snippet/command_line/sspm/main_command.rb

@@ -40,7 +40,7 @@ EOF
         }
       end.map do |sub_command|
         "    #{to_command_name(sub_command[:sym])}\t#{sub_command[:instance].desc}"
-      end.join("\n")
+      end.join($/)
     end
 
     def find_subcommand(command_name)

data/lib/social_snippet/command_line/sspm/sub_commands.rb

@@ -15,3 +15,4 @@ require_relative "sub_commands/info_command"
 require_relative "sub_commands/update_command"
 require_relative "sub_commands/publish_command"
 require_relative "sub_commands/config_command"
+require_relative "sub_commands/init_command"

data/lib/social_snippet/command_line/sspm/sub_commands/init_command.rb

@@ -0,0 +1,27 @@
+module SocialSnippet::CommandLine
+
+  # TODO: $ sspm init --no-prompt
+  class SSpm::SubCommands::InitCommand < Command
+
+    def usage
+      <<EOF
+Usage:
+    $ sspm init
+    -> Generate snippet.json interactively
+EOF
+    end
+
+    def desc
+      "Generate snippet.json interactively"
+    end
+
+    def define_options
+    end
+
+    def run
+      social_snippet.api.init_manifest options
+    end
+
+  end
+
+end

data/lib/social_snippet/core.rb

@@ -1,13 +1,4 @@
-require "tsort"
-
-# Extend Hash tsortable
-class Hash
-  include TSort
-  alias tsort_each_node each_key
-  def tsort_each_child(node, &block)
-    fetch(node).each(&block)
-  end
-end
+require "highline"
 
 class SocialSnippet::Core
 
@@ -18,6 +9,7 @@ class SocialSnippet::Core
   attr_reader :registry_client
   attr_reader :logger
   attr_reader :api
+  attr_reader :prompt
 
   # Constructor
   def initialize(new_input_stream = STDIN, new_output_stream = STDOUT)
@@ -25,6 +17,7 @@ class SocialSnippet::Core
     @output_stream  = new_output_stream
     @config = ::SocialSnippet::Config.new(self)
     @logger = ::SocialSnippet::Logger.new output_stream
+    @prompt = ::HighLine.new(input_stream, output_stream)
     init_logger
 
     @repo_manager = ::SocialSnippet::Repository::RepositoryManager.new(self)

data/lib/social_snippet/inserter.rb

@@ -58,7 +58,7 @@ class SocialSnippet::Inserter
   #
   # @return [String]
   def to_s
-    dest.join("\n")
+    dest.join($/)
   end
 
 end

data/lib/social_snippet/repository/repository_manager.rb

@@ -44,7 +44,7 @@ module SocialSnippet::Repository
     # @param context [::SocialSnippet::Context] The context of snippet
     # @param tag [::SocialSnippet::Tag] The tag of snippet
     def get_snippet(context, tag)
-      return ::SocialSnippet::Snippet.new(resolve_snippet_path(context, tag))
+      ::SocialSnippet::Snippet.new(resolve_snippet_path(context, tag))
     end
 
     # Resolve snippet path from tag

data/lib/social_snippet/resolvers/dep_resolver.rb

@@ -49,7 +49,7 @@ module SocialSnippet
           :context => new_context,
         })
         # find more deps 
-        found_tags.push *find_func(snippet.lines, new_context, tag)
+        found_tags.push *find_func(snippet.lines.to_a, new_context, tag)
       end
 
       return found_tags

data/lib/social_snippet/resolvers/insert_resolver.rb

@@ -3,13 +3,21 @@ module SocialSnippet
   class Resolvers::InsertResolver < Resolvers::BaseResolver
 
     attr_reader :deps_resolver
+    attr_reader :options
 
     # Constructor
     #
     # @param social_snippet [::SocialSnippet::Core]
-    def initialize(social_snippet)
+    def initialize(social_snippet, new_options = {})
+      @options = new_options
       @deps_resolver = Resolvers::DepResolver.new(social_snippet)
       super(social_snippet)
+      init_options
+    end
+
+    def init_options
+      options[:margin_bottom] = options.fetch(:margin_bottom, 0)
+      options[:margin_top] = options.fetch(:margin_top, 0)
     end
 
     # Insert snippets to given text
@@ -17,14 +25,14 @@ module SocialSnippet
     # @param src [Array<String>] The text of source code
     def insert(src)
       context = Context.new("")
-      lines = src.split("\n")
+      lines = src.split($/)
 
       TagParser.find_snippet_tags(lines).each do |tag_info|
         visit tag_info[:tag]
       end
 
       dest = insert_func(lines, context)
-      return dest.join("\n")
+      return dest.join($/)
     end
 
     private
@@ -51,15 +59,19 @@ module SocialSnippet
 
     # Insert snippet by tag and context
     def insert_by_tag_and_context!(inserter, snippet, context, tag)
-      src = insert_func(snippet.lines, context, tag)
+      src = insert_func(snippet.lines.to_a, context, tag)
+
+      options[:margin_top].times { inserter.insert "" }
       inserter.insert tag.to_snippet_tag # @snip -> @snippet
       inserter.insert src
+      options[:margin_bottom].times { inserter.insert "" }
+
       visit tag
     end
 
     # Insert depended snippet
     def insert_depended_snippets!(inserter, snippet, context, tag)
-      dep_tags = deps_resolver.find(snippet.lines, context, tag)
+      dep_tags = deps_resolver.find(snippet.lines.to_a, context, tag)
       dep_tags = sort_dep_tags_by_dep(dep_tags)
 
       dep_tags.each do |tag_info|
@@ -85,7 +97,7 @@ module SocialSnippet
       end
 
       # generate dependency graph
-      dep_tags_hash = {}
+      dep_tags_hash = TSortableHash.new
       dep_tags.each do |tag_info|
         tag = tag_info[:tag].to_path
         dep_ind = dep_tags_index[tag]