hexp 0.0.1.pre

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+before_install: gem install bundler
+bundler_args: --without yard guard benchmarks
+script: "bundle exec rake ci:metrics"
+rvm:
+  - ree
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+  - rbx-19mode
+  - jruby-19mode
+  - jruby-head
+notifications:
+  email:
+    recipients:
+      - arne@arnebrasseur.net
+    on_success: never
+    on_failure: change

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+group :development do
+  gem 'devtools', :git => 'https://github.com/datamapper/devtools.git'
+  gem 'json', '~> 1.7.7'
+  eval File.read('Gemfile.devtools')
+end

data/Gemfile.devtools

@@ -0,0 +1,60 @@
+# encoding: utf-8
+
+group :development do
+  gem 'rake',  '~> 10.0.4'
+  gem 'rspec', '~> 2.13.0'
+  gem 'yard',  '~> 0.8.6.1'
+end
+
+group :yard do
+  gem 'kramdown', '~> 1.0.1'
+end
+
+group :guard do
+  gem 'guard',         '~> 1.8.0'
+  gem 'guard-bundler', '~> 1.0.0'
+  gem 'guard-rspec',   '~> 2.5.4'
+
+  # file system change event handling
+  gem 'listen',     '~> 1.0.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
+
+  # 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
+end
+
+group :metrics do
+  gem 'backports',       '~> 3.3', '>= 3.3.0'
+  gem 'coveralls',       '~> 0.6.6'
+  gem 'flay',            '~> 2.2.0'
+  gem 'flog',            '~> 4.0.0'
+  gem 'reek',            '~> 1.3.1', :git => 'https://github.com/troessner/reek.git'
+  gem 'simplecov',       '~> 0.7.1'
+  gem 'yardstick',       '~> 0.9.6'
+
+  platforms :ruby_19 do
+    gem 'yard-spellcheck', '~> 0.1.5'
+  end
+
+  platforms :mri_19, :rbx do
+    gem 'mutant', '~> 0.2.20'
+  end
+
+  platforms :rbx do
+    gem 'pelusa', '~> 0.2.2'
+  end
+end
+
+group :benchmarks do
+  gem 'rbench', '~> 0.2.3'
+end
+
+platform :jruby do
+  group :jruby do
+    gem 'jruby-openssl', '~> 0.8.5'
+  end
+end

data/Gemfile.lock

@@ -0,0 +1,169 @@
+GIT
+  remote: https://github.com/datamapper/devtools.git
+  revision: f0e3a3a42673266c46b983bc79a4ab6e1623bccc
+  specs:
+    devtools (0.0.1)
+      ice_nine (~> 0.7.0)
+
+GIT
+  remote: https://github.com/troessner/reek.git
+  revision: 79e1b9bb5400d5aba172cbab5e65531daab24b3e
+  specs:
+    reek (1.3.1)
+      ruby2ruby (~> 2.0.2)
+      ruby_parser (~> 3.1.1)
+      sexp_processor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    abstract_type (0.0.5)
+      backports (~> 3.0, >= 3.0.3)
+    adamantium (0.0.7)
+      backports (~> 3.0, >= 3.0.3)
+      ice_nine (~> 0.7.0)
+    backports (3.3.1)
+    coderay (1.0.9)
+    colorize (0.5.8)
+    coveralls (0.6.7)
+      colorize
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      thor
+    descendants_tracker (0.0.1)
+    diff-lcs (1.2.4)
+    equalizer (0.0.5)
+      adamantium (~> 0.0.6)
+      backports (~> 3.0, >= 3.0.3)
+    ffi (1.8.1)
+    ffi-hunspell (0.3.0)
+      ffi (~> 1.0)
+    flay (2.2.0)
+      ruby_parser (~> 3.0)
+      sexp_processor (~> 4.0)
+    flog (4.0.0)
+      ruby_parser (~> 3.1, > 3.1.0)
+      sexp_processor (~> 4.0)
+    formatador (0.2.4)
+    guard (1.8.0)
+      formatador (>= 0.2.4)
+      listen (>= 1.0.0)
+      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 (2.5.4)
+      guard (>= 1.1)
+      rspec (~> 2.11)
+    ice_nine (0.7.0)
+    inflecto (0.0.2)
+    json (1.7.7)
+    kramdown (1.0.2)
+    libnotify (0.8.0)
+      ffi (>= 1.0.11)
+    listen (1.0.3)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+      rb-kqueue (>= 0.2)
+    lumberjack (1.0.3)
+    method_source (0.8.1)
+    mime-types (1.23)
+    multi_json (1.7.3)
+    mutant (0.2.20)
+      abstract_type (~> 0.0.3)
+      adamantium (~> 0.0.7)
+      backports (~> 3.0, >= 3.0.3)
+      descendants_tracker (~> 0.0.1)
+      diff-lcs (~> 1.2.1)
+      equalizer (~> 0.0.5)
+      ice_nine (~> 0.7.0)
+      inflecto (~> 0.0.2)
+      rspec (~> 2.13.0)
+      to_source (~> 0.2.19)
+    mutant-melbourne (2.0.3)
+    pelusa (0.2.2)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.0.4)
+    rb-fchange (0.0.6)
+      ffi
+    rb-fsevent (0.9.3)
+    rb-inotify (0.9.0)
+      ffi (>= 0.5.0)
+    rb-kqueue (0.2.0)
+      ffi (>= 0.5.0)
+    rb-notifu (0.0.4)
+    rbench (0.2.3)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    ruby2ruby (2.0.5)
+      ruby_parser (~> 3.1)
+      sexp_processor (~> 4.0)
+    ruby_parser (3.1.3)
+      sexp_processor (~> 4.1)
+    sexp_processor (4.2.1)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    slop (3.4.5)
+    terminal-notifier-guard (1.5.3)
+    thor (0.18.1)
+    to_source (0.2.20)
+      abstract_type (~> 0.0.5)
+      adamantium (~> 0.0.7)
+      equalizer (~> 0.0.5)
+      mutant-melbourne (~> 2.0.3)
+    yard (0.8.6.1)
+    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
+  ruby
+
+DEPENDENCIES
+  backports (~> 3.3, >= 3.3.0)
+  coveralls (~> 0.6.6)
+  devtools!
+  flay (~> 2.2.0)
+  flog (~> 4.0.0)
+  guard (~> 1.8.0)
+  guard-bundler (~> 1.0.0)
+  guard-rspec (~> 2.5.4)
+  jruby-openssl (~> 0.8.5)
+  json (~> 1.7.7)
+  kramdown (~> 1.0.1)
+  libnotify (~> 0.8.0)
+  listen (~> 1.0.2)
+  mutant (~> 0.2.20)
+  pelusa (~> 0.2.2)
+  rake (~> 10.0.4)
+  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 (~> 1.3.1)!
+  rspec (~> 2.13.0)
+  simplecov (~> 0.7.1)
+  terminal-notifier-guard (~> 1.5.3)
+  yard (~> 0.8.6.1)
+  yard-spellcheck (~> 0.1.5)
+  yardstick (~> 0.9.6)

data/README.md

@@ -0,0 +1,16 @@
+hexp
+====
+
+[![Gem Version](https://badge.fury.io/rb/hexp.png)][gem]
+[![Build Status](https://secure.travis-ci.org/plexus/hexp.png?branch=master)][travis]
+[![Dependency Status](https://gemnasium.com/plexus/hexp.png)][gemnasium]
+[![Code Climate](https://codeclimate.com/github/plexus/hexp.png)][codeclimate]
+[![Coverage Status](https://coveralls.io/repos/plexus/hexp/badge.png?branch=master)][coveralls]
+
+[gem]: https://rubygems.org/gems/dm-mapper
+[travis]: https://travis-ci.org/plexus/hexp
+[gemnasium]: https://gemnasium.com/plexus/hexp
+[codeclimate]: https://codeclimate.com/github/plexus/hexp
+[coveralls]: https://coveralls.io/r/plexus/hexp
+
+HTML expressions

data/Rakefile

@@ -0,0 +1,13 @@
+require 'devtools'
+require 'rubygems/package_task'
+
+Devtools.init_rake_tasks
+
+spec = Gem::Specification.load(File.expand_path('../hexp.gemspec', __FILE__))
+gem = Gem::PackageTask.new(spec)
+gem.define
+
+desc "Push gem to rubygems.org"
+task :push => :gem do
+  sh "gem push pkg/hexp-#{Hexp::VERSION}.gem"
+end

data/SPEC.md

@@ -0,0 +1,53 @@
+# HTML Expressions (hexp) Specification
+
+HTML Expressions, hexps for short, are a subset of s-expressions. They provide a convention for working with HTML data in applications in a structured fashion.
+
+Most languages contain a DOM implementation to work with HTML/XML documents, fragments and nodes. However, generating HTML through the DOM API is verbose and tedious. A hexp implementation SHOULD implement conversions from and to DOM documents. A hexp implementation SHOULD NOT convert directly from or to HTML.
+
+A hexp implementation MUST implement hexp normalization. Several shorthands are provided for the convenience of the programmer when entering literal hexps. These non-strict hexps should be normalized to strict hexps before further manipulation.
+
+## Strict hexps
+
+A strict hexp is a triplet, it represents a single HTML node. The first element is the tag name, the second a dictionary of attributes, the third is a list of child nodes.
+
+If the language implements the concept of a symbol (interned string), the tag name MUST BE a symbol. Otherwise it will be represented as a regular string.
+
+The attributes are represented in a dictionary (hash), with both keys and values being strings.
+
+The list of child nodes is a list (array) of other hexps or strings, the latter representing text nodes in the corresponding DOM.
+
+An example in Ruby of a strict hexp :
+
+````ruby
+[:div, {'class': 'hexp-example'}, [
+    [:p, {}, "Hello, world"]
+  ]
+]
+````
+
+A normalized hexp MUST be made immutable (frozen, persistent) if the runtime supports it. Operations that alter a hexp MUST return a new hexp values, rather than changing the hexp value in-place.
+
+## Non-strict hexps
+
+Following simplifications are allowed for entering literal hexps, the implementation MUST provide a mechanism for converting these to strict hexps.
+
+````ruby
+# non-strict -> strict
+[:p]                            -> [:p, {}, []]
+[:p, {'class' => 'foo'}]        -> [:p, {'class' => 'foo'}, []]
+[:p, ['hello,', [:br], 'world'] -> [:p, {}, ['hello,', [:br, {}, []], 'world']
+````
+
+### Omitting attributes or children
+
+If the dictionary of attributes is empty, it may be omitted.
+
+If the list of children is empty, it may be omitted.
+
+### A single text node as child
+
+If the represented node its only child is a text node, a single string may be given rather than a list of children. An example would be `<p>Hello, world</p>`, this can be represented as `[:p, "Hello, world"]`, which would be normalized to `[:p, {}, ["Hello, world"]]`.
+
+### Standard coercion protocol
+
+In a dynamically typed object-oriented language, a convention may be set for a protocol that objects can implement to return a strict hexp representation of themselves. For Ruby this will be the `to_hexp` method. In the list of children, objects can be added that implement `to_hexp`. The normalization procedure must detect that the object implements this method, and add the resulting hexps to the list of children.

data/config/flay.yml

@@ -0,0 +1,3 @@
+---
+threshold: 10
+total_score: 74

data/config/flog.yml

@@ -0,0 +1,2 @@
+---
+threshold: 11.7

data/config/mutant.yml

@@ -0,0 +1,2 @@
+name: hexp
+namespace: Hexp

data/config/reek.yml

@@ -0,0 +1,100 @@
+---
+Attribute:
+  enabled: true
+  exclude: []
+BooleanParameter:
+  enabled: true
+  exclude: []
+ClassVariable:
+  enabled: true
+  exclude: []
+ControlParameter:
+  enabled: true
+  exclude: []
+DataClump:
+  enabled: true
+  exclude: []
+  max_copies: 0
+  min_clump_size: 1
+DuplicateMethodCall:
+  enabled: true
+  exclude: []
+  max_calls: 1
+  allow_calls: []
+FeatureEnvy:
+  enabled: true
+  exclude: []
+IrresponsibleModule:
+  enabled: true
+  exclude: []
+LongParameterList:
+  enabled: true
+  exclude: []
+  max_params: 1
+  overrides: {}
+LongYieldList:
+  enabled: true
+  exclude: []
+  max_params: 0
+NestedIterators:
+  enabled: true
+  exclude: []
+  max_allowed_nesting: 1
+  ignore_iterators: []
+NilCheck:
+  enabled: true
+  exclude: []
+RepeatedConditional:
+  enabled: true
+  exclude: []
+  max_ifs: 1
+TooManyInstanceVariables:
+  enabled: true
+  exclude: []
+  max_instance_variables: 12
+TooManyMethods:
+  enabled: true
+  exclude: []
+  max_methods: 15
+TooManyStatements:
+  enabled: true
+  exclude: []
+  max_statements: 5
+UncommunicativeMethodName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^[a-z]$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UncommunicativeModuleName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  accept: []
+UncommunicativeParameterName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UncommunicativeVariableName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UnusedParameters:
+  enabled: true
+  exclude: []
+UtilityFunction:
+  enabled: true
+  exclude: []
+  max_helper_calls: 0

data/config/yardstick.yml

@@ -0,0 +1,2 @@
+---
+threshold: 100

data/hexp.gemspec

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+require File.expand_path('../lib/hexp/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = 'hexp'
+  gem.version     = Hexp::VERSION
+  gem.authors     = [ 'Arne Brasseur' ]
+  gem.email       = [ 'arne@arnebrasseur.net' ]
+  gem.description = 'HTML expressions'
+  gem.summary     = gem.description
+  gem.homepage    = 'https://github.com/plexus/hexp'
+
+  gem.require_paths    = %w[lib]
+  gem.files            = `git ls-files`.split($/)
+  gem.test_files       = `git ls-files -- spec`.split($/)
+  gem.extra_rdoc_files = %w[README.md]
+
+  gem.add_dependency 'ice_nine', '~> 0.7.0'
+end

data/lib/hexp.rb

@@ -0,0 +1,5 @@
+module Hexp
+end
+
+require 'hexp/version'
+require 'hexp/array'

data/lib/hexp/array.rb

@@ -0,0 +1,43 @@
+module Hexp
+  class Array < ::Array
+    def self.[](*args)
+      super(*normalize(args))
+    end
+
+    def self.normalize(args)
+      idx = 0
+      case args[idx]
+      when Symbol
+        tag = args[idx] ; idx+=1
+        attrs = case args[idx]
+                when Hash
+                  idx += 1 ; args[idx-1]
+                else
+                  {}
+                end
+        children = normalize_children args[idx]
+        [tag, attrs, children]
+      end
+    end
+
+    def self.normalize_children(children)
+      case children
+      when String
+        [ children ]
+      when ::Array
+        children.map do |child|
+          case child
+          when String
+            child
+          when ::Array
+            Hexp::Array[*child]
+          else
+            raise "bad input #{child}"
+          end
+        end
+      else
+        []
+      end
+    end
+  end
+end

data/lib/hexp/version.rb

@@ -0,0 +1,3 @@
+module Hexp
+  VERSION = '0.0.1.pre'
+end

data/spec/shared_helper.rb

@@ -0,0 +1 @@
+require 'hexp'

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+# SimpleCov MUST be started before require 'hexp'
+#
+if ENV['COVERAGE'] == 'true'
+  require 'simplecov'
+  require 'coveralls'
+
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
+  ]
+
+  SimpleCov.start do
+    command_name 'spec:unit'
+
+    # add_filter 'config'
+
+    # add_group 'Finalizer',    'lib/data_mapper/finalizer'
+
+    minimum_coverage 98.10  # 0.10 lower under JRuby
+  end
+
+end
+
+require 'shared_helper' # requires hexp

data/spec/unit/hexp/array_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+H=Hexp::Array
+
+describe Hexp::Array do
+  describe 'normalization' do
+    describe 'with a single parameter' do
+      it 'should return a triplet' do
+        H[:div].count.should == 3
+      end
+      it 'should treat the first as the tag' do
+        H[:div][0].should == :div
+      end
+      it 'should set an empty attribute list' do
+        H[:div][1].should == {}
+      end
+      it 'should set an empty children list' do
+        H[:div][2].should == []
+      end
+    end
+
+    describe 'with two parameters' do
+      it 'should treat the first as the tag' do
+        H[:div, {class: 'foo'}][0].should == :div
+      end
+      it 'should treat the second as the attribute list, if it is a Hash' do
+        H[:div, {class: 'foo'}][1].should == {class: 'foo'}
+      end
+      it 'should treat the second as a list of children, if it is an Array' do
+        H[:div, []][2].should == []
+      end
+    end
+
+    describe 'with a single text child node' do
+      it 'should set is as the single child' do
+        H[:div, "this is text in the div"][2].should == ["this is text in the div"]
+      end
+    end
+
+    describe 'with child nodes' do
+      it 'must normalize them recursively' do
+        H[:div, [
+            [:h1, "Big Title"],
+            [:p, {class: 'greeting'}, "hello world"],
+            "Some loose text"
+          ]
+        ][2].should == [
+            [:h1, {},                  ["Big Title"]   ],
+            [:p,  {class: 'greeting'}, ["hello world"] ],
+            "Some loose text"
+          ]
+      end
+    end
+
+    describe 'with bad input' do
+      it 'should raise exception' do
+        expect { H[:p, {}, [123]] }.to raise_exception
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: hexp
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre
+  prerelease: 6
+platform: ruby
+authors:
+- Arne Brasseur
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ice_nine
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+description: HTML expressions
+email:
+- arne@arnebrasseur.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Gemfile.devtools
+- Gemfile.lock
+- README.md
+- Rakefile
+- SPEC.md
+- config/flay.yml
+- config/flog.yml
+- config/mutant.yml
+- config/reek.yml
+- config/yardstick.yml
+- hexp.gemspec
+- lib/hexp.rb
+- lib/hexp/array.rb
+- lib/hexp/version.rb
+- spec/shared_helper.rb
+- spec/spec_helper.rb
+- spec/unit/hexp/array_spec.rb
+homepage: https://github.com/plexus/hexp
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3692654222847691207
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: HTML expressions
+test_files:
+- spec/shared_helper.rb
+- spec/spec_helper.rb
+- spec/unit/hexp/array_spec.rb