design-storyboard 0.8.3 → 0.9.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29dc8b5a787823d5d17a4155906248812e57c3fd
-  data.tar.gz: 74aa0cc54eaeab3bb31e2be874c694f55338c6ee
+  metadata.gz: 42fe2d78b430bef7d7ed2494940ddcb4c849284a
+  data.tar.gz: 4af6ad87288e8d5422a404528b24b2c585ed1032
 SHA512:
-  metadata.gz: 0b7ef3e48f18bd0760a8fbccc7d856fe5ece59e262e6db76880706bfd8ecd7d2f590e91327dccc86dc222c189204d26346fca63ca6bd7314bda6bcf08419e3dd
-  data.tar.gz: 3812e7997be5881e0a96bfe9889d28abd255d585fea4217d3bfcb85e8f758102c1356f578e54791a5744c8deb1f6bab543c1c7cf1b9479bac5d0bca161f26d46
+  metadata.gz: 4be77f001a00605d1b4b24fe51a54650b74e43b6886e7629f87a8ac1795f33757a5858c5173a95eef0622d2f9edd950f689a958d6eb6ac3d909ef9751297629c
+  data.tar.gz: 0831985d8b17f30588622790364936f30fcf5d49c6a69c807710fe6be6a91cdba57a02ea01597dbdb12208e14f5c0ae3f3d4ed2fcd05fb9e0ff1609f2e4b0b3f

data/README.md

@@ -17,7 +17,7 @@ gem install design-storyboard
 # How to use?
 
 ```shell
-story build STORY_FILE_PATH
+story build INPUT_FILE_PATH
 ```
 or try 「story help」for more information.
 

data/design_storyboard.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Guanting Chen (guanting886)"]
   spec.email         = ["cgt886@gmail.com"]
   spec.summary       = %q{Easy to building design-storyboard.}
-  # spec.description   = %q{easy to building text-storyboard.}
-  spec.homepage      = "https://github.com/guanting886/"
+  spec.description   = %q{這是一隻可方便您製作 操作流程、分鏡 的 Ruby 程式，用一般書寫文字的方式，就可以把流程細節整理好，印在網頁上及輸出PDF（詳細內容請參閱 Github Repo 上的 README 說明）}
+  spec.homepage      = "https://github.com/guanting886/design-storyboard"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -29,8 +29,8 @@ A new command `story` was added, enjoy!
 
 $ story help
 Commands:
-  story build [STORY_FILE_PATH]             # Build storyboard (html) from story file.
-  story build [STORY_FILE_PATH] --open      # Save file and open storeboard file with browser (Mac Only)
+  story build [INPUT_FILE_PATH]             # Build storyboard (html) from story file.
+  story build [INPUT_FILE_PATH] --open      # Save file and open storeboard file with browser (Mac Only)
   story version                             # Prints version
 
 ---------------------------------------

data/lib/design_storyboard/assets/css/storyboard.css

@@ -0,0 +1,104 @@
+
+a {
+  color: #0375AA;
+}
+
+a:hover {
+  color: orange;
+}
+
+.page-title h1 {
+  font-weight: normal;
+  text-align: center;
+}
+
+body {
+  font-family: \5FAE\8EDF\6B63\9ED1\9AD4, "Helvetica Neue", Helvetica, Arial,
+               "Hiragino Kaku Gothic ProN", "Lantinghei TC", sans-serif;
+
+  font-size: 15px;
+  line-height: 24px;
+}
+
+.container {
+  width: 1000px;
+  margin: 0 auto;
+}
+
+.footer {
+  width: 1000px;
+  margin: 0 auto;
+  text-align: center;
+}
+
+.copyright-info {
+  line-height: 130px;
+}
+
+.tag-1 {
+  color: #E8180E;
+  margin-left: 3px;
+  margin-right: 3px;
+}
+
+.tag-2 {
+  color: #0090FF;
+}
+
+.tag-3 {
+  color: green;
+  margin-left: 3px;
+  margin-right: 3px;
+}
+
+.storyboard {
+  width: 100%;
+}
+
+.storyboard th {
+  content: "xX";
+}
+
+.storyboard tr.headline td {
+  color: white;
+  background-color: #0075AA !important;
+}
+
+.storyboard td {
+  color: #333333;
+  font-size: 13px;
+  vertical-align: top;
+  border-right: 1px solid #DDDDDD;
+  border-bottom: 1px solid #DDDDDD;
+
+  transition-property: background-color, color;
+  transition-duration: 0.5s;
+  transition-timing-function: ease;
+}
+
+.storyboard td img {
+  width: 100%;
+}
+
+.storyboard tr:hover td {
+  color: white;
+  background-color: #333333 !important;
+}
+
+.storyboard .col-1 {
+  width: 50px;
+}
+
+.storyboard .col-2 {
+  width: 500px;
+}
+
+.storyboard .col-1 div {
+  width: 40px;
+  display: block;
+  margin: 0 auto;
+}
+
+.storyboard tr:nth-child(odd) td {
+  background-color: #F5F5F5;
+}

data/lib/design_storyboard/cli.rb

@@ -1,5 +1,6 @@
 # encoding: utf-8
 
+require 'fileutils'
 require 'design_storyboard'
 require 'thor'
 require 'design_storyboard/version'
@@ -8,9 +9,9 @@ module DesignStoryboard
   class Cli < Thor
 
     option :open, :type => :boolean
-    desc 'build [STORY_FILE_PATH] --open', 'Build storyboard (html) from file.'
+    desc 'build [INPUT_FILE_PATH] --open', 'Build storyboard (html) from file.'
     def build(path)
-      Setting[:story_file_path] = path
+      Setting[:input_file_path] = path
       Setting.update_dump_data_path
       Setting[:auto_open] = true if options[:open]
 

data/lib/design_storyboard/export.rb

@@ -2,6 +2,21 @@
 
 module DesignStoryboard
   module Export
+    @storyboard_cols_count = 0
+
+    REGEXP_RULE_FOR_FIND_LINK = /
+      (?:link|url):[[:blank:]]*(?<uri>[\w\_\-]+:\/\/[\S]+)
+    /xi
+
+    REGEXP_RULE_FOR_FIND_LINK_AND_TITLE = /
+      (?:link|url):[[:blank:]]*(?<uri>[\w\_\-]+:\/\/[\S]+)
+      [[:blank:]]*\|[[:blank:]]*
+      (?:caption|title):[[:blank:]]*(?<title>[\S]+)
+    /xi
+
+    REGEXP_RULE_FOR_FIND_IMAGE = /
+      (?:images|image|img|picture|pic):[[:blank:]]*(?<uri>[\w\_\-]+:\/\/[\S]+)
+    /xi
 
     def apply_html_template(title, html_syntax)
       html = %Q(
@@ -9,12 +24,19 @@ module DesignStoryboard
 <html>
 <head>
   <meta charset="utf-8">
+  <title>#{title} by Design Storyboard</title>
   <meta http-equiv="X-UA-Compatible" content="IE=edge">
-  <link rel="stylesheet" href="css/storyboard.css">
+  <link rel="stylesheet" href="#{Setting[:stylesheet_path]}">
 </head>
 <body>
   <div class="page-title"><h1>#{title}</h1></div>
   <div class="container">#{html_syntax}</div>
+  <div class="footer">
+    <div class="copyright-info">Powered by
+      <a target="_blank" href="https://github.com/guanting886/design-storyboard">Design Storyboard</a>
+      節省您作業時間的好工具 😎
+    </div>
+  </div>
 </body>
 </html>
       )
@@ -24,22 +46,34 @@ module DesignStoryboard
       html = '<tr>'
 
       args.each_with_index do |value, index|
-        value.gsub!(/[\r\n]+/, '<br>')
+
         value.gsub!(/\[(?<tag1>[^\]]+)\]/, '<span class="tag-1">[\k<tag1>]</span>')
         value.gsub!(/\「(?<tag2>[^\」]+)\」/, '<span class="tag-2">「\k<tag2>」</span>')
         value.gsub!(/\((?<tag3>[^\」]+)\)/, '<span class="tag-3">(\k<tag3>)</span>')
         value.gsub!(/\（(?<tag3>[^\」]+)\）/, '<span class="tag-3">(\k<tag3>)</span>')
-        html << "<td class='td-#{index}'><div>#{value}</div></td>"
+        value.gsub!(REGEXP_RULE_FOR_FIND_LINK_AND_TITLE, '<a href="\k<uri>" target="_blank">\k<title></a>')
+        value.gsub!(REGEXP_RULE_FOR_FIND_LINK, '<a href="\k<uri>" target="_blank">\k<uri></a>')
+        value.gsub!(REGEXP_RULE_FOR_FIND_IMAGE, '<img src="\k<uri>">')
+
+        value.gsub!(/[\r\n]+/, '<br>')
+
+        html << "<td class='col-#{index+1}'><div>#{value}</div></td>"
       end
 
       html << '</tr>'
     end
 
+    def generate_table_headline(title)
+      "<tr class='headline'><td colspan='#{@storyboard_cols_count}'>#{title}</td></tr>"
+    end
+
     def generate_table_header(*args)
+      @storyboard_cols_count = args.length
+
       html = '<tr>'
 
-      args.each do |value|
-        html << "<th>#{value}</th>"
+      args.each_with_index do |value, index|
+        html << "<th class='col-#{index+1}'>#{value}</th>"
       end
 
       html << '</tr>'
@@ -60,8 +94,15 @@ module DesignStoryboard
       table_header_html = generate_table_header('Step', 'Description', 'Note')
       table_cells_html  = ""
 
-      info_collection.each do |index, info|
-        table_cells_html << generate_table_cell(info[:step], info[:description], info[:note])
+      info_collection.each do |info|
+
+        if info.is_a? Hash
+          table_cells_html << generate_table_cell(info[:step], info[:description], info[:note])
+        elsif info.is_a? String
+          table_cells_html << generate_table_headline(info)
+        else
+          # ignore
+        end
       end
 
       table_html    = generate_table(table_header_html, table_cells_html)
@@ -82,9 +123,17 @@ module DesignStoryboard
       title 'Here you are'
       attention Setting[:dump_file_path]
 
+      create_css   if Setting[:auto_create_css]
       open_browser if Setting[:auto_open]
     end
 
+    def create_css
+      assets_dir_css_path  = File.join(Setting[:assets_path], Setting[:stylesheet_dir_name], Setting[:stylesheet_file_name])
+      release_dir_css_path = File.join(Setting[:dump_dir_path], Setting[:stylesheet_dir_name], Setting[:stylesheet_file_name])
+
+      FileUtils.cp assets_dir_css_path, release_dir_css_path if not File.exist? release_dir_css_path
+    end
+
     def open_browser
       `open "#{Setting[:dump_file_path]}"`
     end

data/lib/design_storyboard/setting.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 module DesignStoryboard
+
   module Setting
 
     @settings = {}
@@ -17,20 +18,37 @@ module DesignStoryboard
       all[key] = value
     end
 
+    def self.create_important_folder
+      FileUtils.mkpath File.join(Setting[:dump_dir_path])
+      FileUtils.mkpath File.join(Setting[:dump_dir_path], Setting[:stylesheet_dir_name]) if Setting[:auto_create_css]
+    end
+
     def self.update_dump_data_path
-      Setting[:dump_file_path] = "#{Setting[:story_file_path]}.html"
+      new_filename = File.basename(Setting[:input_file_path], ".*")
+
+      Setting[:dump_dir_path]  = File.join(File.dirname(Setting[:input_file_path]), Setting[:release_dir_name])
+      Setting[:dump_file_path] = File.join(Setting[:dump_dir_path], "#{new_filename}.html")
+
+      create_important_folder
 
       update_page_title
     end
 
     def self.update_page_title
-      Setting[:page_title] = File.basename(Setting[:story_file_path], ".*")
+      Setting[:page_title] = File.basename(Setting[:input_file_path], ".*")
     end
 
   end
 
-  Setting[:story_file_path] = ''
-  Setting[:dump_file_path]  = ''
-  Setting[:page_title]      = ''
-  Setting[:auto_open]       = false
+  Setting[:release_dir_name]     = 'release'
+  Setting[:stylesheet_dir_name]  = 'css'
+  Setting[:stylesheet_file_name] = 'storyboard.css'
+  Setting[:stylesheet_path]      = File.join(Setting[:stylesheet_dir_name], Setting[:stylesheet_file_name])
+  Setting[:assets_path]          = File.join(File.dirname(__FILE__), 'assets')
+  Setting[:input_file_path]      = ''
+  Setting[:dump_dir_path]        = ''
+  Setting[:dump_file_path]       = ''
+  Setting[:page_title]           = ''
+  Setting[:auto_open]            = false
+  Setting[:auto_create_css]      = true 
 end

data/lib/design_storyboard/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module DesignStoryboard
-  VERSION = "0.8.3"
+  VERSION = "0.9.5"
 end

data/lib/design_storyboard.rb

@@ -1,5 +1,4 @@
 # encoding: utf-8
-
 require 'design_storyboard/ext'
 require 'design_storyboard/export'
 require 'design_storyboard/log'
@@ -23,43 +22,50 @@ module DesignStoryboard
     def generate_storyboard_from_story_file
       start
 
-      storyboard           = {}
-      scene                = { step: '', description: '', note: '' }
-      step_number          = ""
+      story_collection     = {}
+      headline_collection  = {}
+      story                = { step: '', description: '', note: '' }
+      step_number          = "0"
       step_number_is_found = false
       note_number_is_found = false
 
       alert 'Start analyzing.'
 
-      IO.foreach(Setting[:story_file_path]) do |data|
+      IO.foreach(Setting[:input_file_path]) do |data|
         data              = data.remove_white_char
-        scene_number_info = data.match(/step[[:blank:]]+(?<scene_number>[\d\-]+)\:/i)
-        note_number_info  = data.match(/\^{4}[[:blank:]]+(?<scene_number>[\d\-]+)\:/i)
+        match_step_number = data.match(/step[[:blank:]]+(?<step_number>[\d\-]+)\:/i)
+        match_note_number = data.match(/(?:note|\^{4})[[:blank:]]+(?<step_number>[\d\-]+)\:/i)
+        match_headline    = data.match(/\={4,}[[:blank:]]*(?<headline>[\S]+)[[:blank:]]*\={4,}/i)
+        
+        if match_headline.present?
+          headline_collection[step_number] = match_headline[:headline]
+          next
+        end
 
-        if scene_number_info.present?
+        if match_step_number.present?
           step_number_is_found = true
           note_number_is_found = false
 
-          step_number                           = scene_number_info[1]
-          storyboard[step_number]               = scene.dup
-          storyboard[step_number][:step]        = step_number
-          storyboard[step_number][:description] = ""
+          step_number                                 = match_step_number[:step_number]
+          story_collection[step_number]               = story.dup
+          story_collection[step_number][:step]        = step_number
+          story_collection[step_number][:description] = ""
 
           say "catch <- #{step_number}"
 
-        elsif note_number_info.present?
+        elsif match_note_number.present?
           step_number_is_found = false
           note_number_is_found = true
 
-          storyboard[step_number][:note] = ""
+          story_collection[step_number][:note] = ""
 
           say "catch note <- #{step_number}"
 
         elsif step_number_is_found
-          storyboard[step_number][:description] << data
+          story_collection[step_number][:description] << data
 
         elsif note_number_is_found
-          storyboard[step_number][:note] << data
+          story_collection[step_number][:note] << data
 
         else
           # ignore
@@ -67,10 +73,34 @@ module DesignStoryboard
       end
 
       done
+
     rescue Exception => e
       runtime_error e
     ensure
-      return storyboard
+      return make_storyboard(headline_collection, story_collection)
+    end
+
+    def make_storyboard(headline_collection, story_collection)
+      storyboard = []
+
+      if headline_collection.present?
+        if headline_collection.has_key? "0"
+          storyboard.push headline_collection["0"]
+          headline_collection.delete("0")
+        end
+      end
+
+      story_collection.each do |index, story|
+        storyboard.push story
+
+        step_number = story[:step]
+
+        if headline_collection.has_key? step_number
+          storyboard.push headline_collection[step_number]
+        end
+      end
+
+      storyboard
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: design-storyboard
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.9.5
 platform: ruby
 authors:
 - Guanting Chen (guanting886)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-23 00:00:00.000000000 Z
+date: 2015-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,7 +52,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.18'
-description: 
+description: "這是一隻可方便您製作 操作流程、分鏡 的 Ruby 程式，用一般書寫文字的方式，就可以把流程細節整理好，印在網頁上及輸出PDF（詳細內容請參閱
+  Github Repo 上的 README 說明）"
 email:
 - cgt886@gmail.com
 executables:
@@ -68,13 +69,14 @@ files:
 - bin/story
 - design_storyboard.gemspec
 - lib/design_storyboard.rb
+- lib/design_storyboard/assets/css/storyboard.css
 - lib/design_storyboard/cli.rb
 - lib/design_storyboard/export.rb
 - lib/design_storyboard/ext.rb
 - lib/design_storyboard/log.rb
 - lib/design_storyboard/setting.rb
 - lib/design_storyboard/version.rb
-homepage: https://github.com/guanting886/
+homepage: https://github.com/guanting886/design-storyboard
 licenses:
 - MIT
 metadata: {}
@@ -85,8 +87,8 @@ post_install_message: |
 
   $ story help
   Commands:
-    story build [STORY_FILE_PATH]             # Build storyboard (html) from story file.
-    story build [STORY_FILE_PATH] --open      # Save file and open storeboard file with browser (Mac Only)
+    story build [INPUT_FILE_PATH]             # Build storyboard (html) from story file.
+    story build [INPUT_FILE_PATH] --open      # Save file and open storeboard file with browser (Mac Only)
     story version                             # Prints version
 
   ---------------------------------------