opulent 1.1.6 → 1.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6daf567113902547514da9b31c194ca45587239
-  data.tar.gz: 21ed11e388a2cdf395adadc22b22599ff034c30d
+  metadata.gz: e4e6711a377fd5f4bdb35c0d1acb44a542e2ad86
+  data.tar.gz: 2df71d3a64fb210a6b0853285fff5d82e4a7363c
 SHA512:
-  metadata.gz: aa4b1110a6588609be2b67b1cbeffd7331cade6abcacac05935fbddf5aa7996fed7b115f5da47b3c7e501e2a05b31f303445ac0e9b401f996a033ee914a26775
-  data.tar.gz: 57a2e9efab145024e4b7ff18109d2a244e15ab3677b679ed4937e68caa2db9b66effc68faed0e667e4c7d8e564a5989aef10cb8c1f9600751f56bc918c5e5325
+  metadata.gz: 20aa32c2d2edf206eef8eafaff65255fe0039ad10cfdaa92af9be2fdd890d1d91c99dd38b46780c28e8ba86cb76bd0c0207b6a06388fb1ee925dc5149eedd2d7
+  data.tar.gz: a4a00b6cb4be54cb77a56aba84978e8a3e196b299c8bab178c721770ec508297476f97d98742942aa4a1965c870826ab7db44dc5add25549f4e031d7ef7d5890

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Pixevil
+Copyright (c) 2015 Alex Grozav (Pixevil)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,10 +1,10 @@
 # Opulent
 
-Opulent is an __Intelligent Web Templating Engine__ created for extremly fast, efficient and DRY Web Development. Based on the idea of creating lightweight __Web Component__ definitions, Opulent greatly speeds up the development process of any project.
+Opulent is an __Intelligent Web Templating Engine__ created for extremely fast and efficient Web Development. Based on the idea of lightweight and reusable __Web Components__, Opulent greatly increases your development speed for any project.
 
 ## Syntax
 
-Opulent is as beautiful as it gets: no tags, indentation based, optional brackets, inline text, inline children and in page definitions.
+Opulent has a beautiful, minimalistic syntax: no tags, indentation based, optional brackets, inline text, inline children and in page definitions.
 
 __Page Markup__
 ```
@@ -40,7 +40,7 @@ ul.navbar
 
 __Starting to feel it?__ There's so much more you can do with Opulent.
 
-[Read the Documentation](docs/syntax.md)
+[Read the Documentation](docs/reference.md)
 
 
 

data/docs/attributes.md

@@ -0,0 +1,164 @@
+# Opulent Attributes
+Tag attributes are similar to CSS or HTML, but their values are regular embedded Ruby.
+
+### Shorthand Attributes
+You can use the shorthand attributes exactly as you would in your CSS markup, the syntax is very similar.
+
+The default node for the shorthand attributes is the __div__ node, since it's the most widely used HTML Element.
+
+__Example__
+```scss
+.container.text-center
+
+#content
+
+#main.center
+
+div#block.new
+
+input&email
+```
+
+```html
+<div class="container text-center"></div>
+
+<div id="content"></div>
+
+<div id="main" class="center"></div>
+
+<div id="block" class="new"></div>
+
+<input name="email">
+```
+
+
+### Wrapped Attributes
+You can either use equals symbol '__=__' or colon symbol '__:__' to set a value for an attribute.
+
+The difference between wrapped and unwrapped (inline) attributes is that you can use complex Ruby expressions such as boolean operations, comparisons or ternary operators.
+
+The attributes in wrapped mode are separated by a comma '__,__' or semicolon '__;__'.
+
+The node's __class__ attribute values are gathered into an array, while the other attributes will be replaced.
+
+Attributes can be wrapped in round __(exp)__, square __[exp]__ and curly __{exp}__ brackets.
+
+__Example 1__
+```html
+a(href="http://google.com") Google
+a(href: "http://google.com") Google
+
+a[href="http://google.com"] Google
+a[href: "http://google.com"] Google
+
+a{href="http://google.com"} Google
+a{href: "http://google.com"} Google
+```
+
+```html
+<a href="http://google.com">Google</a>
+```
+
+__Example 2__
+
+```html
+div(class: "HELLO".downcase, class: "world")
+```
+
+```html
+<div class="hello world"></div>
+```
+
+__Example 3__
+```html
+a(class=["btn", "btn-primary"])
+```
+
+```html
+<a class="btn btn-primary"></a>
+```
+
+__Example 4__
+```html
+example(attr1=1 + 2 + 3, attr2="hello " + "world")
+```
+
+```html
+<example attr1="6" attr2="hello world"></example>
+```
+
+### Unwrapped Attributes
+Inline attributes can be used without any wrapping brackets and they allow you to use simple expressions such as method calls and index accessors.
+
+__Example 1__
+```html
+a href="http://google.com" Google
+
+a href="http://google.com" class="button" Google
+```
+
+```
+<a href="http://google.com">Google</a>
+
+<a href="http://google.com" class="button">Google</a>
+```
+
+__Example 2__
+```html
+a class=["btn", "btn-primary"] Button
+```
+
+```html
+<a class="btn btn-primary">Button</a>
+```
+
+### Escaping Attributes
+Attributes are escaped by default, unless passed as node definition arguments.
+
+You can use a tilde symbol '__~__' after the assignment operator to explicitly set the attribute value as unescaped.
+
+__Example__
+```html
+div escaped="<div></div>"
+div unescaped=~"<div></div>"
+```
+
+```html
+<div escaped="&lt;div&gt;&lt;/div&gt;"></div>
+<div unescaped="<div></div>"></div>
+```
+
+Unescaped buffered code can be dangerous. You must be sure to sanitize any user inputs to avoid cross-site scripting.
+
+### Extending Attributes
+Attributes can be extended using a '__+__' symbol, followed by an expression which returns a Hash.
+
+__Example__
+```html
+a+({href: "http://opulent.io", class: "btn btn-black"}) Opulent
+```
+```html
+<a href="http://opulent.io" class="btn btn-black">Opulent</a>
+```
+
+
+### Literal Values
+In Opulent, boolean values, arrays and hashes behave differently based on the use context. Arrays will join values using a space when used for class attributes and an underline otherwise. Hashes will extend the current attribute name one level using the hash key.
+
+__Example 1__
+```html
+- hash = {a: 1, b: 2, c: 3}
+div data=hash
+```
+
+```html
+<div data-a="1" data-b="2" data-c="3"></div>
+```
+
+```html
+- array = ['a', 'b', 'c']
+div data=array class=array
+```
+```html
+<div data="a_b_c" class="a b c"></div>
+```

data/docs/control-structures.md

@@ -0,0 +1,91 @@
+# Opulent Control Structures
+
+You can use your favorite control structures from Ruby in Opulent without any hassle. Unlike in most templating engines, control structures do not require a leading dash and can be written like you normally write a node.
+
+### If Structure
+Just like in Ruby, you can use the __if-elsif-else__ structure to write conditional branches. The values false and nil are false, and everything else are true. Notice Ruby and Opulent use elsif, not else if nor elif.
+
+__Example__
+```html
+if user.authenticated?
+  p Welcome #{user.name}
+else
+  p Welcome stranger!
+```
+
+### Unless Structure
+The branch is executed if the condition is false. The unless structure also allows an else branch.
+
+__Example__
+```html
+unless value
+  p Value doesn't exist
+```
+
+### Case Structure
+To handle multiple possible values, the case structure is preferred instead of the if-elsif structure.
+
+__Example__
+```html
+- value = 'a'
+
+case value
+when 'a'
+  p This is a
+when 'b'
+  p This is b
+when 'c'
+  p This is c
+else
+  p This is something else
+```
+
+### Each Structure
+The each structure will iterate through an ennumerable value such as an Array or Hash and allow you to use
+the value and the current index. By default, the variable names are '__key__' and '__value__' but they can be overwritten.
+
+__Example 1__
+```html
+each in ['a', 'b', 'c']
+  p Value at #{key} is #{value}.
+```
+
+```html
+<p>Value at 0 is a.</p>
+<p>Value at 1 is b.</p>
+<p>Value at 2 is c.</p>
+```
+
+__Example 2__
+```html
+each myval in ['1', '2', '3']
+  p Value at #{key} is #{myval}.
+```
+
+__Example 3__
+```html
+each k, v in {a: '1', b: '2', c: '3'}
+  p Value at #{k} is #{v}.
+```
+
+### While Structure
+The while structure will loop until we encounter a false value for the conditional. You will need to update the  conditional variables inside the while loop in order to eventually reach a false value, otherwise it will result in an infinite loop.
+
+__Example__
+```html
+- timer = 10
+while timer > 0
+  p Time remaining: #{timer}
+  - timer -= 1
+```
+
+### Until Structure
+The until structure will loop until we encounter a true value for the conditional.
+
+__Example__
+```html
+- timer = 10
+until timer == 0
+  p Time left: #{timer}
+  - timer -= 1
+```

data/docs/reference.md

@@ -0,0 +1,9 @@
+#Opulent
+Opulent is an __Intelligent Web Templating Engine__ created for extremely fast and efficient Web Development. Based on the idea of lightweight and reusable __Web Components__, Opulent greatly increases your development speed for any project.
+
+### Language Reference
+
+1. [Attributes](attributes.md)
+2. [Control Structures](control-structures.md)
+3. [Expressions](usage.md)
+4. [Comments](usage.md)

data/lib/opulent/version.rb

@@ -1,4 +1,4 @@
 # @Opulent
 module Opulent
-  VERSION = "1.1.6"
+  VERSION = "1.1.7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opulent
 version: !ruby/object:Gem::Version
-  version: 1.1.6
+  version: 1.1.7
 platform: ruby
 authors:
 - Alex Grozav
@@ -129,13 +129,14 @@ files:
 - Gemfile
 - LICENSE
 - README.md
-- Rakefile
 - benchmark/benchmark.rb
 - benchmark/cases/node/node.haml
 - benchmark/cases/node/node.op
 - benchmark/cases/node/node.slim
 - bin/opulent
-- docs/syntax.md
+- docs/attributes.md
+- docs/control-structures.md
+- docs/reference.md
 - docs/usage.md
 - lib/opulent.rb
 - lib/opulent/compiler.rb

data/Rakefile

@@ -1,6 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec

data/docs/syntax.md

@@ -1,3 +0,0 @@
-#Opulent Syntax
-
-@TODO