hexp 0.2.0 → 0.3.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MDg4OWIzYzg3MzRjNTE2Mjk5YTk3NzBiNzYzNmFhMjA4ZWNjNWM3MQ==
+  data.tar.gz: !binary |-
+    NmUyYzliZTM4NDc0MzFhMjJiNTIzYmU4YWNhODE2ZWM0OTkwYTE5Zg==
+SHA512:
+  metadata.gz: !binary |-
+    OTA3ODA1Nzc1MGMzYzIwMDViZjA3NTk2MDcyYzA2ZDNiZTBjMWZlMTZmNjJj
+    NzAyYTMzZjQwOWIzNjRmZWVhNTY0MWU3N2QzMTJhMDliZjdmMGQxNDVhZGVi
+    YjJlZWRhZTcwNDRiYjllOGI0N2JhMjFkMTZmMmQyYjdjOGFkMGQ=
+  data.tar.gz: !binary |-
+    OGVjMGNmNmFmZTFjNzkxNzE3N2ZkY2EwNTNmYzBkOTdmMjcxMWVlNmMwOTg0
+    NzYwMmEyYjBiOWQ3ODY3MzM4Y2MyNDIwZDY1ODMyZjk0NjhkZjEyN2EzOTBl
+    NWM5YWFkMDBkYTBkNTMxNmQ2ODc0MTA0YTNhYzBlZTExMmY0Mjg=

data/.gitignore

@@ -11,6 +11,7 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+vendor
 
 # YARD artifacts
 .yardoc
@@ -19,3 +20,6 @@ doc/
 
 #yardstick report
 measurements/report.txt
+
+# Automatic Ruby switching
+.ruby-version

data/.travis.yml

@@ -6,8 +6,8 @@ rvm:
   - 1.9.2
   - 1.9.3
   - 2.0.0
+  - 2.1.0
   - ruby-head
-  - rbx-19mode
 matrix:
   include:
     - rvm: jruby-19mode
@@ -15,10 +15,9 @@ matrix:
     - rvm: jruby-head
       env: JRUBY_OPTS="$JRUBY_OPTS --debug"
   allow_failures:
+    - rvm: jruby-19mode
     - rvm: ruby-head
-    - rvm: rbx-19mode
     - rvm: jruby-head
-    - rvm: jruby-19mode
 notifications:
   email:
     recipients:

data/.yardopts

@@ -0,0 +1 @@
+--no-private -q - LICENSE

data/Gemfile.devtools

@@ -2,8 +2,8 @@
 
 group :development do
   gem 'rake',  '~> 10.1.0'
-  gem 'rspec', '~> 2.14.0'
-  gem 'yard',  '~> 0.8.6.2'
+  gem 'rspec', '~> 2.14.1'
+  gem 'yard',  '~> 0.8.7'
 end
 
 group :yard do
@@ -15,40 +15,33 @@ group :guard do
   gem 'guard-bundler', '~> 1.0.0'
   gem 'guard-rspec',   '~> 3.0.2'
   gem 'guard-rubocop', '~> 0.2.0'
+  # gem 'guard-mutant',  '~> 0.0.1'
 
   # file system change event handling
-  gem 'listen',     '~> 1.2.2'
-  gem 'rb-fchange', '~> 0.0.6', :require => false
-  gem 'rb-fsevent', '~> 0.9.3', :require => false
-  gem 'rb-inotify', '~> 0.9.0', :require => false
+  gem 'listen',     '~> 1.3.0'
+  gem 'rb-fchange', '~> 0.0.6', require: false
+  gem 'rb-fsevent', '~> 0.9.3', require: false
+  gem 'rb-inotify', '~> 0.9.0', require: false
 
   # notification handling
-  gem 'libnotify',               '~> 0.8.0', :require => false
-  gem 'rb-notifu',               '~> 0.0.4', :require => false
-  gem 'terminal-notifier-guard', '~> 1.5.3', :require => false
+  gem 'libnotify',               '~> 0.8.0', require: false
+  gem 'rb-notifu',               '~> 0.0.4', require: false
+  gem 'terminal-notifier-guard', '~> 1.5.3', require: false
 end
 
 group :metrics do
   gem 'coveralls', '~> 0.6.7'
-  gem 'flay',      '~> 2.3.0'
-  gem 'flog',      '~> 4.1.0'
-  gem 'reek',      github: 'troessner/reek'
-  gem 'rubocop',   '~> 0.9.1'
-  gem 'simplecov', github: 'colszowka/simplecov'
-  gem 'yardstick', '~> 0.9.6'
+  gem 'flay',      '~> 2.4.0'
+  gem 'flog',      '~> 4.1.1'
+  gem 'reek',      '~> 1.3.2'
+  gem 'rubocop',   '~> 0.11.0'
+  gem 'simplecov', '~> 0.7.1'
+  gem 'yardstick', '~> 0.9.7', git: 'https://github.com/dkubb/yardstick.git'
 
   platforms :ruby_19, :ruby_20 do
-    #gem 'mutant',          '~> 0.3.0.beta13'
+    # gem 'mutant', git: 'https://github.com/mbj/mutant.git'
     gem 'yard-spellcheck', '~> 0.1.5'
   end
-
-  platforms :ruby_19 do
-    gem 'json', '~> 1.8.0'
-  end
-
-  platforms :rbx do
-    gem 'pelusa', '~> 0.2.2'
-  end
 end
 
 group :benchmarks do

data/Gemfile.lock

@@ -1,190 +1,185 @@
-GIT
-  remote: git://github.com/colszowka/simplecov.git
-  revision: a3387f7b25100939df6a5af339580cbe3055cdc6
-  specs:
-    simplecov (0.8.0.pre)
-      multi_json
-      simplecov-html (~> 0.7.1)
-
 GIT
   remote: git://github.com/rom-rb/devtools.git
-  revision: 49e6b05b9915c990a2e45dc24f7318b4d7a95e88
+  revision: 6c73036e93244e6392504bfe226139181589e20d
   specs:
     devtools (0.0.2)
 
 GIT
-  remote: git://github.com/troessner/reek.git
-  revision: c901c37f8a1de8e8a89221710ae37ea89a768db0
+  remote: https://github.com/dkubb/yardstick.git
+  revision: 3d0b28f2044cb9e33353c962d3d8f833ed764045
   specs:
-    reek (1.3.2)
-      ruby2ruby (~> 2.0.2)
-      ruby_parser (~> 3.1.1)
-      sexp_processor
+    yardstick (0.9.9)
+      yard (~> 0.8, >= 0.8.7.2)
 
 PATH
   remote: .
   specs:
-    hexp (0.2.0)
+    hexp (0.3.0)
       equalizer (~> 0.0)
-      ice_nine (~> 0.8)
+      ice_nine (~> 0.9)
       nokogiri (~> 1.6)
       sass (~> 3.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    adamantium (0.0.11)
-      ice_nine (~> 0.8.0)
     ast (1.1.0)
-    backports (3.3.3)
+    backports (3.3.5)
+    benchmark-ips (1.2.0)
+    benchmark_suite (1.0.0)
+      benchmark-ips (~> 1.0)
     bouncy-castle-java (1.5.0147)
-    coderay (1.0.9)
-    colorize (0.5.8)
-    coveralls (0.6.7)
-      colorize
+    coderay (1.1.0)
+    coveralls (0.6.9)
       multi_json (~> 1.3)
       rest-client
       simplecov (>= 0.7)
+      term-ansicolor
       thor
-    diff-lcs (1.2.4)
-    equalizer (0.0.5)
-      adamantium (~> 0.0.6)
-      backports (~> 3.0, >= 3.0.3)
-    ffi (1.9.0)
-    ffi (1.9.0-java)
+    diff-lcs (1.2.5)
+    equalizer (0.0.9)
+    ffi (1.9.3)
+    ffi (1.9.3-java)
     ffi-hunspell (0.3.0)
       ffi (~> 1.0)
-    flay (2.3.1)
+    flay (2.4.0)
       ruby_parser (~> 3.0)
       sexp_processor (~> 4.0)
-    flog (4.1.1)
+    flog (4.1.2)
       ruby_parser (~> 3.1, > 3.1.0)
       sexp_processor (~> 4.0)
     formatador (0.2.4)
-    guard (1.8.2)
+    guard (1.8.3)
       formatador (>= 0.2.4)
-      listen (>= 1.0.0)
+      listen (~> 1.3)
       lumberjack (>= 1.0.2)
       pry (>= 0.9.10)
       thor (>= 0.14.6)
     guard-bundler (1.0.0)
       bundler (~> 1.0)
       guard (~> 1.1)
-    guard-rspec (3.0.2)
+    guard-rspec (3.0.3)
       guard (>= 1.8)
       rspec (~> 2.13)
-    guard-rubocop (0.2.1)
+    guard-rubocop (0.2.2)
       guard (~> 1.8)
-      rubocop (~> 0.9)
-    ice_nine (0.8.0)
-    jruby-openssl (0.8.8)
+      rubocop (~> 0.10)
+    ice_nine (0.11.0)
+    jruby-openssl (0.8.10)
       bouncy-castle-java (>= 1.5.0147)
-    json (1.8.0)
     kramdown (1.1.0)
-    libnotify (0.8.1)
+    libnotify (0.8.2)
       ffi (>= 1.0.11)
-    listen (1.2.3)
+    listen (1.3.1)
       rb-fsevent (>= 0.9.3)
       rb-inotify (>= 0.9)
       rb-kqueue (>= 0.2)
     lumberjack (1.0.4)
     method_source (0.8.2)
-    mime-types (1.24)
-    mini_portile (0.5.1)
-    multi_json (1.7.9)
-    nokogiri (1.6.0)
+    mime-types (2.1)
+    mini_portile (0.5.2)
+    multi_json (1.8.4)
+    nokogiri (1.6.1)
       mini_portile (~> 0.5.0)
-    nokogiri (1.6.0-java)
+    nokogiri (1.6.1-java)
       mini_portile (~> 0.5.0)
-    parser (2.0.0.pre1)
+    parser (2.0.0)
       ast (~> 1.1)
       slop (~> 3.4, >= 3.4.5)
-    pelusa (0.2.2)
-    pry (0.9.12.2)
-      coderay (~> 1.0.5)
+    powerpack (0.0.9)
+    pry (0.9.12.5)
+      coderay (~> 1.0)
       method_source (~> 0.8)
       slop (~> 3.4)
-    pry (0.9.12.2-java)
-      coderay (~> 1.0.5)
+    pry (0.9.12.5-java)
+      coderay (~> 1.0)
       method_source (~> 0.8)
       slop (~> 3.4)
       spoon (~> 0.0)
-    rainbow (1.1.4)
-    rake (10.1.0)
+    rainbow (2.0.0)
+    rake (10.1.1)
     rb-fchange (0.0.6)
       ffi
-    rb-fsevent (0.9.3)
-    rb-inotify (0.9.1)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.3)
       ffi (>= 0.5.0)
     rb-kqueue (0.2.0)
       ffi (>= 0.5.0)
     rb-notifu (0.0.4)
     rbench (0.2.3)
+    reek (1.3.6)
+      ruby2ruby (~> 2.0.7)
+      ruby_parser (~> 3.2)
+      sexp_processor
     rest-client (1.6.7)
       mime-types (>= 1.16)
     rspec (2.14.1)
       rspec-core (~> 2.14.0)
       rspec-expectations (~> 2.14.0)
       rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.5)
-    rspec-expectations (2.14.2)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
       diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.3)
-    rubocop (0.9.1)
-      parser (= 2.0.0.pre1)
+    rspec-mocks (2.14.4)
+    rubocop (0.11.1)
+      backports (~> 3.3.3)
+      parser (~> 2.0.0.pre6)
+      powerpack (~> 0.0.3)
       rainbow (>= 1.1.4)
-    ruby2ruby (2.0.6)
+    ruby2ruby (2.0.7)
       ruby_parser (~> 3.1)
       sexp_processor (~> 4.0)
-    ruby_parser (3.1.3)
+    ruby_parser (3.3.0)
       sexp_processor (~> 4.1)
-    sass (3.2.10)
-    sexp_processor (4.2.1)
+    sass (3.2.14)
+    sexp_processor (4.4.1)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
     simplecov-html (0.7.1)
-    slop (3.4.6)
+    slop (3.4.7)
     spoon (0.0.4)
       ffi
+    term-ansicolor (1.2.2)
+      tins (~> 0.8)
     terminal-notifier-guard (1.5.3)
     thor (0.18.1)
-    yard (0.8.6.2)
+    tins (0.13.1)
+    yard (0.8.7.3)
     yard-spellcheck (0.1.5)
       ffi-hunspell (~> 0.2)
       yard (~> 0.6)
-    yardstick (0.9.6)
-      backports (~> 3.3, >= 3.3.0)
-      yard (~> 0.8, >= 0.8.6)
 
 PLATFORMS
   java
   ruby
 
 DEPENDENCIES
+  benchmark_suite (~> 1.0)
   coveralls (~> 0.6.7)
   devtools!
-  flay (~> 2.3.0)
-  flog (~> 4.1.0)
+  flay (~> 2.4.0)
+  flog (~> 4.1.1)
   guard (~> 1.8.1)
   guard-bundler (~> 1.0.0)
   guard-rspec (~> 3.0.2)
   guard-rubocop (~> 0.2.0)
   hexp!
   jruby-openssl (~> 0.8.5)
-  json (~> 1.8.0)
   kramdown (~> 1.1.0)
   libnotify (~> 0.8.0)
-  listen (~> 1.2.2)
-  pelusa (~> 0.2.2)
+  listen (~> 1.3.0)
   rake (~> 10.1.0)
   rb-fchange (~> 0.0.6)
   rb-fsevent (~> 0.9.3)
   rb-inotify (~> 0.9.0)
   rb-notifu (~> 0.0.4)
   rbench (~> 0.2.3)
-  reek!
-  rspec (~> 2.14.0)
-  rubocop (~> 0.9.1)
-  simplecov!
+  reek (~> 1.3.2)
+  rspec (~> 2.14.1)
+  rubocop (~> 0.11.0)
+  simplecov (~> 0.7.1)
   terminal-notifier-guard (~> 1.5.3)
-  yard (~> 0.8.6.2)
+  yard (~> 0.8.7)
   yard-spellcheck (~> 0.1.5)
-  yardstick (~> 0.9.6)
+  yardstick (~> 0.9.7)!

data/README.md

@@ -10,10 +10,19 @@
 [codeclimate]: https://codeclimate.com/github/plexus/hexp
 [coveralls]: https://coveralls.io/r/plexus/hexp
 
-A bit about hexps
------------------
+# Hexp
 
-**What on earth is a Hexp?**
+**Hexp** (pronounced [ˈɦækspi:]) is a Ruby API for creating and manipulating HTML syntax trees. It enables a web application architecture where HTML is only ever represented as structured data, rather than as plain text.
+
+Only when the data needs to be serialized and sent over the network is it converted to a string representation. This has a number of advantages.
+
+* Single responsibility : HTML generation is not mixed with business logic
+* Security : Protection from XSS (cross-site scripting)
+* Productivity : components that create or alter fragments of a HTML become generic, reusable parts
+
+For a more in-depth explanation please see the slides of talk [Web Linguistics, Towards Higher Fluency](http://arnebrasseur.net/talks/eurucamp2013/presentation.html) given at Eurucamp 2013. (the video is not available yet.)
+
+**Creating Hexps**
 
 Hexps are basically snippets of HTML written in nothing but Ruby, here's an example.
 
@@ -25,6 +34,8 @@ Hexps are basically snippets of HTML written in nothing but Ruby, here's an exam
 ]
 ````
 
+For more info to get you up and running have a look at the API documentation for [Hexp::Node](http://plexus.github.io/hexp/Hexp/Node.html).
+
 **Don't people use templates for this kind of thing?**
 
 They do, this is an alternative approach. With templates you need to think about which parts need to be HTML-escaped, or you can make errors like forgetting a closing tag. With hexps you no longer need to think about escaping.
@@ -84,14 +95,18 @@ The entire API is centered around these two classes, and one of them you can thi
 A note on immutability
 ----------------------
 
-All Hexp objects are deep frozen on creation, you can never alter them afterwards. Operations always return a new `Hexp::Node` rather than working in place.
+All Hexp objects are frozen on creation, you can never alter them afterwards. Operations always return a new `Hexp::Node` rather than working in place.
 
 This might seem stringent when you are not used to this style of coding, but it's a pattern that generally promotes good code.
 
 Can I already use it
 --------------------
 
-Hold your horses, this is *very* alpha level code! Feedback is very much appreciated, so try it out, and let me know what you think. Basic functionality is there, but it's far from finished, and the API will probably still change based on feedback. You have been warned.
+Yes, but there are some things to keep in mind.
+
+For the 0.x line of versions Hexp is not restricted to [semantic versioning](http://semver.org). We are still designing the API, and small backwards incompatible changes may occur. However given that the project's aim is to only provide the lowest level of DOM manipulation upon which others can built, it is already quite feature complete. It shouldn't be too long before we release a 1.0.0, after which we will commit to semantic versioning.
+
+Another thing is that Hexp is young. It hasn't been battle tested yet, and the ecosystem which will make this approach truly attractive is yet to emerge. Therefore better try it out on smaller, non-critical projects first, and give us your feedback.
 
 Is it any good?
 ---------------
@@ -108,8 +123,3 @@ At this point you're best off grabbing the Git repo, e.g. with bundler
 
 gem 'hexp', github: 'plexus/hexp'
 ````
-
-Who is behind this
-------------------
-
-Hexp is conceived and created by [Arne Brasseur](http://arnebrasseur.net)