slight-lang 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c879ef00340954d40021fd0a09592e77e6a2ae64
-  data.tar.gz: 3db13c8f77e7fa90297f6e449fae62cf25aacf43
+  metadata.gz: a2fb6397892fd342cc22a6e31478efbbc6ca5744
+  data.tar.gz: ec9f31523e9a92a671bdfb19b2ce05c943516855
 SHA512:
-  metadata.gz: e1421b653fb2043448cdfcd18ea31206cca601173e6ceaae4c24fd7c1bcba09dba4177693da3ff367e928a6413ab3ea44c639ed8a9387b28b4c1b32632ae8dd1
-  data.tar.gz: 207e469de27f2ac0a9dd9a020d993728ef8e3ff4f55ad0be4df624ad9cf0704c311be59b9df5fe7dc8001a1a3df87acf226d95e12754e531248005fc28c9f8b7
+  metadata.gz: e6928741a6d117a8d18cb48d8f94df7965edcf286147d9dc35b8d4adebf8e9d742125d4da0d0e93c48d94391becc0c66ecb9a9890429428eb977570e0826542b
+  data.tar.gz: '089f7d90260ad1b5c6712903621af6bba9fd48479b18f91dc73c4fab26be66cef920f6ec3854511e54eccdeb992b1ff949732fb378ad7098223069d52494ad98'

data/README.md

@@ -1,12 +1,10 @@
 # Slight-lang
 A light and sweet template language.
 
-## Description
-Slight is a very simple and easy to use template language.
-Advantage of Slight:
+with:
 - Pure Ruby syntax
 - Html friendly
-- Nearly 0 learning cost
+- 0 learning cost
 
 ## Quick Start
 #### [Installation]
@@ -14,33 +12,33 @@ Advantage of Slight:
 gem install slight-lang
 
 # you can also build gem from gemspec
-gem build slight.gemspec
-gem install ./slight-lang-1.0.1.gem
+# gem build slight.gemspec
+# gem install ./slight-lang-1.0.5.gem
 ```
 
-#### [Command]
-###### Slight
+#### [Usage]
+###### - Command
 ```bash
-slight [-v] <source> [<output>]
+root@ubuntu: slight [-v] <source> [<output>]
 
-e.g.
-slight index.slight index.htm
-=> index.htm
-
-slight index.slight
-=> <tag>abcde</tag>
-
-slight -v
-=> v 1.0.1
+# slight index.slight index.htm
+# => index.htm
 ```
 
-###### REPL
-```
-slsh
+###### - REPL
+```bash
+root@ubuntu: slsh
 ```
-- build-in commands
-
 ```ruby
+sl:> button 'btn btn-success btn-lg', name:'btn_submit', type:'submit' do
+sl:>    "Submit"
+sl:> end
+sl:> ;   (Enter ';' to run the script)
+
+# compile from file
+sl:> @../../example/component.slight.rb
+LOAD PATH="../../example/component.slight.rb"
+
 # help
 sl:> \h
  @file    => load and compile file dynamically. E.g. @/tmp/page.slight
@@ -48,124 +46,67 @@ sl:> \h
  \eg      => example
  \q       => exit
  \v       => show version (also: \ver, \version)
-
-
-# exit
-sl:> \q  (ctrl + c)
-*** Exit now ***
---bye--
-
-
-# show example
-sl:> \eg
-    button "btn btn-primary" do
-      "Click me"
-    end
-=>
-    <button class="btn btn-primary">Click me</button>
-
-
-# compile slight file
-sl:> @../../example/component.slight.rb
-LOAD PATH="../../example/component.slight.rb"
-<button class="btn btn-success btn-lg">
-submit</button>
-
-
-# redirect output to file
-sl:> >@output.htm  (>@off to turn off)
-spool turned on
-OUTPUT PATH="output.htm"
-```
-- Run Slight in REPL
-
-```ruby
-sl:> button 'btn btn-success btn-lg', name:'btn_submit', type:'submit' do
-sl:>    "Submit"
-sl:> end
-sl:> ;   (Enter ';' to run the script)
-
-<button class="btn btn-success btn-lg" name="btn_submit" type="submit">
-Submit</button>
 ```
 
 #### [Syntax]
 
-- Pure Ruby Syntax
+###### - Pure Ruby Syntax
 
 ```ruby
 tag_name "class", [attributes: id, name, style, etc.] do; <content>; end
 
-e.g.
+# example
 div "panel panel-lg", css: "border: 5 dotted green", id: "msgbox" do
   button "btn btn-primary" do
     "Ok"
   end
-  button "btn btn-default" do
-    "Cancel"
-  end
 end
-
-(of course {} syntax is also spported)
 ```
-- All html tags are supported
+###### - HTML attributes and tags are naturally supported
 
-- Default Build-in Html Shortcuts
+###### - Support Shortcuts for HTML tags and attributes(can be customized)
 
-```ruby  
-[attribute]
-  css   => "style"
-  ln    => "href"
-  url   => "href"
-  char  => "charset"
-  fn    => "src"
-  lang  => "language"
-  xn    => "xmlns"
-  mf    => "manifest"
-
-e.g.
-
-  div css:'border: 10 solid blue' do; "hello"; end
-=>
-  <div style="border: 10 solid blue">
-    Hello
-  <div>
+- Attribute Shortcuts
 
-[tag]
-  _     => "<div>$content</div>"
-  js    => "<script language='javscript'>$content</script>"
-  use   => "<script type='text/javascript' src='$content'></script>"
-  use   => "<link rel='stylesheet' href='$content'></link>"
-  # depends on which file loaded 'use' will determine which tag to replace.
+| shortcut | attribute | shortcut | attribute |
+|-------|--------------| -------|--------------|
+| :css | style | :fn | src |
+| :ln | href | :lang | language |
+| :url | href | :xn | xmlns |
+| :char | charset | :mf | manifest |
 
-e.g.
+```ruby  
+# example
+  div css:'border: 10 solid blue' do; "hello"; end
+# <div style="border: 10 solid blue">
+#   Hello
+# <div>
+```
 
-  _ do; "hello"; end
-=>
-  <div>hello</div>
+- Html Tag Shortcuts
 
+| shortcut | attribute |
+|-------|--------------|
+| _ | &lt;div&gt;$content&lt;/div&gt; |
+| js | &lt;script language='javscript'&gt;$content&lt;/script&gt; |
+| use | &lt;script type='text/javascript' src='$content'&gt;&lt;/script&gt; |
+| use | &lt;link rel='stylesheet' href='$content'&gt;&lt;/link&gt; |
 
+```ruby
+# example
   js %{
     console.log("hello slight");
   }
-=>
-  <script language="javascript">
-    console.log("hello slight");
-  </script>
-
+# <script language="javascript">
+#   console.log("hello slight");
+# </script>
 
   use 'resource/bootstrap.js'
-=>
-  <script type='text/javascript' src='resource/bootstrap.js'></script>
-
-
-  use 'resource/bootstrap.css'
-=>
-  <link rel='stylesheet' href='resource/bootstrap.css'></link>
+# <script type='text/javascript' src='resource/bootstrap.js'></script>
 ```
 
-#### [Customize]
-- general usage (more details please refer to example)
+#### [Customization]
+###### - Usage (more details please refer to example)
 
 ```ruby
 conf = Slight::Configuration.new do |c|
@@ -176,29 +117,25 @@ end
 custom_engine = Slight::Engine.new(conf)
 ```
 
-- supported configuration
+###### - Configuration Options
 
 ```ruby
-conf = Slight::Configuration.new do |c|
-  c.shortcut :A, :endpoint, "href"  #add an attribute shortcut
-  c.shortcut :T, "box", "div"       #add a tag shotcut
-
-  # set output IO
-  c.setIO        STDOUT
-
-  # undef ruby methods in slight context
-  c.blinding     :p, :select, :puts, :send, :class
-
-  # use Filter
-  # Before-Filters accept original source pass the output to Slight compiler.
-  # After-Filters accept output from Slight compiler pass the output to end user.
-  c.use     FilterA, :before
-  c.use     FilterB, :after
-end
+shortcut :A, :endpoint, "href"  #add an attribute shortcut
+shortcut :T, "box", "div"       #add a tag shortcut
+# set output IO
+setIO        STDOUT
+# undef ruby methods in slight context
+blinding     :p, :select, :puts, :send, :class
+# use Filter
+# Before-Filters accept original source pass the output to Slight compiler.
+# After-Filters accept output from Slight compiler pass the output to end user.
+use     FilterA, :before
+use     FilterB, :after
 ```
 
-#### [Tilt]
-- Working with Tilt
+#### [Tilt Intergration]
+
+##### Working with Tilt
 ```ruby
 require 'slight/tilt'
 

data/lib/slight.rb

@@ -2,7 +2,8 @@ require 'slight/engine'
 module Slight
   # Slight version string
   # @api public
-  VERSION = '1.0.5'
+  VERSION = '1.1.0'
   # 1.0.0 => Basic Template features | 201703
-  # 1.0.5 => Support Tilt, Render Scope Binding | 201704
+  # 1.0.5 => Support Tilt | 201704
+  # 1.1.0 => Doc Update | 201705
 end

data/slight.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |gem|
       gem.authors       = ["oliver.yu"]
       gem.email         = ["nemo1023@gmail.com"]
       gem.description   = %q{A light and sweet template language}
-      gem.summary       = %q{The goal of this is to use ruby syntax and html style shotcut to write template.}
+      gem.summary       = %q{The goal of this is to use pure ruby syntax to write template.}
       gem.homepage      = "https://github.com/OliversCat/Slight"
       gem.files         = `git ls-files`.split($\)
       #gem.files         = dir('.')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slight-lang
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - oliver.yu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-20 00:00:00.000000000 Z
+date: 2017-05-10 00:00:00.000000000 Z
 dependencies: []
 description: A light and sweet template language
 email:
@@ -67,5 +67,5 @@ rubyforge_project:
 rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: The goal of this is to use ruby syntax and html style shotcut to write template.
+summary: The goal of this is to use pure ruby syntax to write template.
 test_files: []