togglate 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c7a17708de8171ece04a35fe3cb48503252f276d
-  data.tar.gz: 041375d65bd90df01849fdc07724880e125f0583
+  metadata.gz: a67edbbcb3fc78c147b5d1a686f35091fa974d3a
+  data.tar.gz: 5ff0bdc8a25fcf43b6662f426fcff2d3ebea10b5
 SHA512:
-  metadata.gz: 426662553eede9a73a7b0e1cd895db309eb7a5c7f8cbc7e59d39922df5efde19ba4de05009cc01e476b7a5d27815631a7a679d9c05d3050d6a0cde0f73da3cd1
-  data.tar.gz: 3c47ff9fdaef373c6988a4abe30803b1d872dfd18bd9710e074e91ce1888643ffce7f64c0a002f02c2da5c119e7dfb3e324c8b7fd561c2bfa9b0583d0c361295
+  metadata.gz: 7a5ca7027d328ff4f1e597c2f729f01ffde8129d884328829663dbfb3b72cfd6334b6bd0df08265c984e0e329004b4edc92ef50d73bb0d65827679911d9839bd
+  data.tar.gz: 3101a22687385fe4b7bf891a125d97c1a37a84de565a476f9a1649ee9b1df2c7ba394b77f955a7c876d61f4b60c0341355275ccd4ab3c77411d40e09731b7a65

data/README.md

@@ -1,6 +1,6 @@
 # Togglate
 
-TODO: Write a gem description
+  Togglate is a tool for creating a base text of translation, in which original texts are embeded in a form of comments.
 
 ## Installation
 
@@ -18,7 +18,7 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+See `togglate` command.
 
 ## Contributing
 

data/lib/togglate/block_wrapper.rb

@@ -1,12 +1,9 @@
 class Togglate::BlockWrapper
   def initialize(text,
-                 space_re:/^\s*$/,
-                 chunk_exceptions:[/^```/],
-                 wrapper:%W([translation\ here]\n```original ```),
-                 wrap_exceptions:[/^```/, /^\s{4}/], **opts)
+                 wrapper:%W([translation\ here]\n\n<!--original -->),
+                 wrap_exceptions:[],
+                 **opts)
     @text = text
-    @space_re = space_re
-    @chunk_exceptions = chunk_exceptions
     @wrapper = wrapper
     @wrap_exceptions = wrap_exceptions
   end
@@ -16,11 +13,11 @@ class Togglate::BlockWrapper
   end
 
   private
-  def chunk_by_space
+  def chunk_by_space(block_tags:[/^```/], space_re:/^\s*$/)
     in_block = false
     @text.each_line.chunk do |line|
-      in_block = !in_block if @chunk_exceptions.any? { |ex| line.match ex }
-      !line.match(@space_re).nil? && !in_block
+      in_block = !in_block if block_tags.any? { |ex| line.match ex }
+      !line.match(space_re).nil? && !in_block
     end
   end
 

data/lib/togglate/cli.rb

@@ -3,18 +3,21 @@ require "thor"
 module Togglate
   class CLI < Thor
     desc "create FILE", "Create a base file for translation from a original file"
-    option :toggle_code, aliases:'-t', default:true
-    option :target, type: :string
-    option :show_text, aliases:'-s', type: :string
-    option :hide_text, aliases:'-h', type: :string
-    option :wrapper, type: :array
+    option :method, aliases:'-m', default:'hover', desc:"Select a display method: 'hover' or 'toggle'"
+    option :embed_code, aliases:'-e', default:true, type: :boolean, desc:"Enable code embeding to false"
+    option :toggle_link_text, type: :array, default:["*", "hide"]
+    option :code_block, aliases:'-c', default:false, type: :boolean, desc:"Enable code blocks not to be wrapped"
     def create(file)
       opts = options.inject({}) { |h, (k,v)| h[k.intern] = v; h } # symbolize keys
-      if wrapper = options[:wrapper]
-        wrapper.map! { |wr| wr.gsub(/\\n/, "\n") }
-        opts.update(wrapper:wrapper)
-      end
+      opts.update(wrap_exceptions:[/^```/, /^ {4}/]) if opts[:code_block]
       puts Togglate.create(file, opts)
     end
+
+    desc "version", "Show Togglate version"
+    def version
+      puts "Togglate #{Togglate::VERSION} (c) 2014 kyoendo"
+    end
+    map "-v" => :version
+
   end
 end

data/lib/togglate/version.rb

@@ -1,3 +1,3 @@
 module Togglate
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end

data/lib/togglate.rb

@@ -6,9 +6,9 @@ module Togglate
   def self.create(file, opts={})
     text = File.read(file)
     wrapped = BlockWrapper.new(text, opts).run
-    if opts[:toggle_code]
-      code = toggle_code(opts)
-      [wrapped, code].join("\n")
+    if opts[:embed_code]
+      code = append_code(opts[:method], opts)
+      "#{wrapped}\n#{code}"
     else
       wrapped
     end
@@ -17,26 +17,51 @@ module Togglate
     exit
   end
 
-  def self.toggle_code(target:%($("pre[lang='original']")), show_text:"*", hide_text:"hide", **opts)
+  def self.append_code(method, opts)
+    send("#{method}_code", opts)
+  end
+
+  def self.toggle_code(name:'original', toggle_link_text:["*", "hide"], **opts)
+    <<-"CODE"
+<script src="http://code.jquery.com/jquery-1.11.0.min.js"></script>
+<script>
+$(function() {
+  $("*").contents().filter(function() {
+    return this.nodeType==8 && this.nodeValue.match(/^#{name}/);
+  }).each(function(i, e) {
+    var tooltips = e.nodeValue.replace(/^#{name} *[\\n\\r]|[\\n\\r]$/g, '');
+    var link = "<span><a href='#' onclick='javascript:return false;' class='toggleLink'>" + "#{toggle_link_text[0]}" + "</a></span>";
+    $(this).prev().append(link);
+    $(this).prev().after("<pre style='display:none'>"+ tooltips + "</pre>");
+  });
+
+  $('.toggleLink').click(
+    function() {
+      if ($(this).text()=="#{toggle_link_text[0]}") {
+       $(this).parent().parent().next('pre').slideDown(200);
+       $(this).text("#{toggle_link_text[1]}");
+      } else {
+        $(this).parent().parent().next('pre').slideUp(200);
+        $(this).text("#{toggle_link_text[0]}");
+      };
+    });
+});
+</script>
+CODE
+  end
+
+  def self.hover_code(name:'original', **opts)
     <<-"CODE"
 <script src="http://code.jquery.com/jquery-1.11.0.min.js"></script>
 <script>
-function createToggleLinks(target, showText, hideText) {
-var link = "<span><a href='#' onclick='javascript:return false;' class='toggleLink'>" + showText + "</a></span>";
-target.hide().prev().append(link);
-$('.toggleLink').click(
-  function() {
-    if ($(this).text()==showText) {
-     $(this).parent().parent().next(target).slideDown(200);
-     $(this).text(hideText);
-    } else {
-      $(this).parent().parent().next(target).slideUp(200);
-      $(this).text(showText);
-    };
+$(function() {
+  $("*").contents().filter(function() {
+    return this.nodeType==8 && this.nodeValue.match(/^#{name}/);
+  }).each(function(i, e) {
+    var tooltips = e.nodeValue.replace(/^#{name}\s*[\\n\\r]|[\\n\\r]$/g, '');
+    $(this).prev().attr('title', tooltips);
   });
-}
-var element = #{target};
-createToggleLinks(element, "#{show_text}", "#{hide_text}");
+});
 </script>
 CODE
   end

data/spec/fixtures/README.md

@@ -0,0 +1,12 @@
+# Title
+
+Title is a tool.
+
+    % ruby title.rb
+
+
+```ruby
+def hello
+  puts :hello
+end
+```

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'togglate'
+require "stringio"
 
 class String
   def ~
@@ -7,3 +8,13 @@ class String
     gsub(/^ {#{margin}}/, '')
   end
 end
+
+module Helpers
+  def source_root
+    File.join(File.dirname(__FILE__), 'fixtures')
+  end
+end
+
+RSpec.configure do |c|
+  c.include Helpers
+end

data/spec/togglate_cli_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+describe Togglate::CLI do
+  before do
+    $stdout, $stderr = StringIO.new, StringIO.new
+    @original_dir = Dir.pwd
+    Dir.chdir(source_root)
+  end
+
+  after do
+    $stdout, $stderr = STDOUT, STDERR
+    Dir.chdir(@original_dir)
+  end
+
+  describe "#create" do
+    context "wrap_exceptions option" do
+      it "wraps sentences" do
+        Togglate::CLI.start(['create', 'README.md'])
+        expect($stdout.string).to match(/<!--original\n# Title\n-->/)
+      end
+
+      it "wraps code blocks" do
+        Togglate::CLI.start(['create', 'README.md'])
+        expect($stdout.string).to match(/<!--original\n\s{4}% ruby title\.rb\n-->/)
+      end
+
+      it "wraps gfm code blocks" do
+        Togglate::CLI.start(['create', 'README.md'])
+        expect($stdout.string).to match(/<!--original.*```ruby.*```\n-->/m)
+      end
+
+      it "wraps sentences except code blocks" do
+        Togglate::CLI.start(['create', 'README.md', '--code-block'])
+        expect($stdout.string).to match(/^\n {4}% ruby title\.rb\n$/)
+        expect($stdout.string).to match(/^\n```ruby.*```\n$/m)
+      end
+    end
+
+    context "code and method option" do
+      it "adds hover code to the output" do
+        Togglate::CLI.start(['create', 'README.md'])
+        expect($stdout.string).to match(/<script.*nodeType==8.*<\/script>/m)
+      end
+
+      it "adds toggle code to the output" do
+        Togglate::CLI.start(['create', 'README.md', '--method=toggle'])
+        expect($stdout.string).to match(/<script.*slideDown.*<\/script>/m)
+      end
+
+      it "not adds code to the output" do
+        Togglate::CLI.start(['create', 'README.md', '--embed-code=false'])
+        expect($stdout.string).not_to match(/<script.*nodeType==8.*<\/script>/m)
+        expect($stdout.string).not_to match(/<script.*createToggle.*<\/script>/m)
+      end
+    end
+
+    context "toggle_link_text option" do
+      it "sets texts for toggle link" do
+        Togglate::CLI.start(['create', 'README.md', '-m=toggle', '--toggle-link-text', 'showme', 'closeme'])
+        expect($stdout.string).to match(/<script.*showme.*<\/script>/m)
+      end
+    end
+  end
+end

data/spec/togglate_spec.rb

@@ -23,7 +23,7 @@ describe Togglate::BlockWrapper do
       text = "#title\n\n\ntext\n"
       wrapper = Togglate::BlockWrapper.new(text)
       chunks = wrapper.send(:chunk_by_space)
-      exp = "<translation here>\n```original\n#title\n```\n\n\n<translation here>\n```original\ntext\n```\n"
+      exp = "[translation here]\n\n<!--original\n#title\n-->\n\n\n[translation here]\n\n<!--original\ntext\n-->\n"
       expect(wrapper.send(:wrap_with, chunks)).to eq exp
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: togglate
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - kyoendo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-09 00:00:00.000000000 Z
+date: 2014-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -86,7 +86,9 @@ files:
 - lib/togglate/block_wrapper.rb
 - lib/togglate/cli.rb
 - lib/togglate/version.rb
+- spec/fixtures/README.md
 - spec/spec_helper.rb
+- spec/togglate_cli_spec.rb
 - spec/togglate_spec.rb
 - togglate.gemspec
 homepage: https://github.com/melborne/togglate
@@ -114,6 +116,8 @@ signing_key:
 specification_version: 4
 summary: Create base text for translation, in which original is togglable
 test_files:
+- spec/fixtures/README.md
 - spec/spec_helper.rb
+- spec/togglate_cli_spec.rb
 - spec/togglate_spec.rb
 has_rdoc: