haml 6.0.0.beta.1-java

data/FAQ.md

@@ -0,0 +1,147 @@
+# Frequently Asked Questions
+
+## Haml
+
+### How do I put a punctuation mark after an element, like "`I like <strong>cake</strong>!`"? {#q-punctuation}
+
+Expressing the structure of a document
+and expressing inline formatting are two very different problems.
+Haml is mostly designed for structure,
+so the best way to deal with formatting is to leave it to other languages
+that are designed for it.
+You could use Textile:
+
+    %p
+      :textile
+        I like *cake*!
+
+or Markdown:
+
+    %p
+      :markdown
+        I like **cake**!
+
+or plain old XHTML:
+
+    %p I like <strong>cake</strong>!
+
+If you're inserting something that's generated by a helper, like a link,
+then it's even easier:
+
+    %p== I like #{link_to 'chocolate', 'http://franschocolates.com'}!
+
+### How do I stop Haml from indenting the contents of my `pre` and `textarea` tags? {#q-preserve}
+
+Because Haml automatically indents the HTML source code,
+the contents of whitespace-sensitive tags like `pre` and `textarea`
+can get screwed up.
+The solution is to replace the newlines inside these tags
+with HTML newline entities (`&#x000A;`),
+which Haml does using the {Haml::Helpers#preserve} and {Haml::Helpers#find_and_preserve} helpers.
+
+Normally, Haml will do this for you automatically
+when you're using a tag that needs it
+(this can be customized using the {Haml::Options#preserve `:preserve`} option).
+For example,
+
+    %p
+      %textarea= "Foo\nBar"
+
+will be compiled to
+
+    <p>
+      <textarea>
+    Foo&#x000A;Bar</textarea>
+    </p>
+
+However, if a helper is generating the tag,
+Haml can't detect that and so you'll have to call {Haml::Helpers#find_and_preserve} yourself.
+You can also use `~`, which is the same as `=`
+except that it automatically runs `find_and_preserve` on its input.
+For example:
+
+    %p= find_and_preserve "<textarea>Foo\nBar</textarea>"
+
+is the same as
+
+    %p~ "<textarea>Foo\nBar</textarea>"
+
+and renders
+
+    <p><textarea>Foo&#x000A;Bar</textarea></p>
+
+### How do I make my long lines of Ruby code look nicer in my Haml document? {#q-multiline}
+
+Put them in a helper or your model.
+
+Haml purposefully makes it annoying to put lots of Ruby code into your templates,
+because lots of code doesn't belong in the view.
+If you take that huge `link_to_remote` call
+and move it to a `update_sidebar_link` helper,
+it'll make your view both easier to read and more semantic.
+
+If you absolutely must put lots of code in your template,
+Haml offers a somewhat awkward multiline-continuation tool.
+Put a `|` (pipe character) at the end of each line you want to be merged into one
+(including the last line!).
+For example:
+
+    %p= @this.is(way.too.much). |
+        code("and I should").   |
+        really_move.it.into(    |
+          :a => @helper)        |
+
+Note that sometimes it is valid to include lots of Ruby in a template
+when that Ruby is a helper call that passes in a lot of template information.
+Thus when a function has lots of arguments,
+it's possible to wrap it across multiple lines
+as long as each line ends in a comma.
+For example:
+
+    = link_to_remote "Add to cart",
+        :url => { :action => "add", :id => product.id },
+        :update => { :success => "cart", :failure => "error" }
+
+### `form_for` is printing the form tag twice!
+
+Make sure you're calling it with `-`, not `=`.
+Just like in ERB, you have to do
+
+    <% form_for stuff do %>
+      ...
+    <% end %>
+
+in Haml, you have to do
+
+    - form_for stuff do
+      ...
+
+### I have Haml installed. Why is Rails (only looking for `.html.erb` files | rendering Haml files as plain text | rendering Haml files as blank pages)? {#q-blank-page}
+
+There are several reasons these things might be happening.
+First of all, make sure that Haml really is installed;
+either you've loaded the gem (via `config.gem` in Rails 2.3 or in the Gemfile in Rails 3),
+or `vendor/plugins/haml` exists and contains files.
+Then try restarting Mongrel or WEBrick or whatever you might be using.
+
+Finally, if none of these work,
+chances are you've got some localization plugin like Globalize installed.
+Such plugins often don't play nicely with Haml.
+Luckily, there's usually an easy fix.
+For Globalize, just edit `globalize/lib/globalize/rails/action_view.rb`
+and change
+
+    @@re_extension = /\.(rjs|rhtml|rxml)$/
+
+to
+
+    @@re_extension = /\.(rjs|rhtml|rxml|erb|builder|haml)$/
+
+For other plugins, a little searching will probably turn up a way to fix them as well.
+
+## You still haven't answered my question!
+
+Sorry! Try looking at the [Haml](http://haml.info/docs/yardoc/file.REFERENCE.html) reference,
+If you can't find an answer there,
+feel free to ask in `#haml` on irc.freenode.net
+or send an email to the [mailing list](http://groups.google.com/group/haml).

data/Gemfile

@@ -0,0 +1,23 @@
+source 'https://rubygems.org'
+
+git_source(:github) do |repo_name|
+  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?("/")
+  "https://github.com/#{repo_name}.git"
+end
+
+# Specify your gem's dependencies in haml.gemspec
+gemspec
+
+gem 'benchmark-ips', '2.3.0'
+gem 'maxitest'
+gem 'pry'
+
+if /java/ === RUBY_PLATFORM # JRuby
+  gem 'pandoc-ruby'
+else
+  gem 'redcarpet'
+
+  if RUBY_PLATFORM !~ /mswin|mingw/ && RUBY_ENGINE != 'truffleruby'
+    gem 'stackprof'
+  end
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2006-2021 Hampton Catlin, Natalie Weizenbaum and Takashi Kokubun
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,210 @@
+# Haml
+
+[![Gem Version](https://badge.fury.io/rb/haml.svg)](http://rubygems.org/gems/haml)
+[![Build Status](https://travis-ci.org/haml/haml.svg?branch=main)](http://travis-ci.org/haml/haml)
+[![Code Climate](https://codeclimate.com/github/haml/haml/badges/gpa.svg)](https://codeclimate.com/github/haml/haml)
+[![Inline docs](http://inch-ci.org/github/haml/haml.png)](http://inch-ci.org/github/haml/haml)
+
+Haml is a templating engine for HTML. It's designed to make it both easier and
+more pleasant to write HTML documents, by eliminating redundancy, reflecting the
+underlying structure that the document represents, and providing an elegant syntax
+that's both powerful and easy to understand.
+
+## Basic Usage
+
+Haml can be used from the command line or as part of a Ruby web framework. The
+first step is to install the gem:
+
+~~~sh
+gem install haml
+~~~
+
+After you write some Haml, you can run
+
+~~~sh
+haml document.haml
+~~~
+
+to compile it to HTML. For more information on these commands, check out
+
+~~~sh
+haml --help
+~~~
+
+To use Haml programmatically, check out the [YARD documentation](http://haml.info/docs/yardoc/).
+
+## Using Haml with Rails
+
+To use Haml with Rails, simply add Haml to your Gemfile and run `bundle`.
+
+~~~ruby
+gem 'haml'
+~~~
+
+If you'd like to replace Rails's Erb-based generators with Haml, add
+[haml-rails](https://github.com/indirect/haml-rails) to your Gemfile as well.
+
+## Formatting
+
+The most basic element of Haml is a shorthand for creating HTML:
+
+~~~haml
+%tagname{:attr1 => 'value1', :attr2 => 'value2'} Contents
+~~~
+
+No end-tag is needed; Haml handles that automatically. If you prefer HTML-style
+attributes, you can also use:
+
+~~~haml
+%tagname(attr1='value1' attr2='value2') Contents
+~~~
+
+Adding `class` and `id` attributes is even easier. Haml uses the same syntax as
+the CSS that styles the document:
+
+~~~haml
+%tagname#id.class
+~~~
+
+In fact, when you're using the `<div>` tag, it becomes _even easier_. Because
+`<div>` is such a common element, a tag without a name defaults to a div. So
+
+~~~haml
+#foo Hello!
+~~~
+
+becomes
+
+~~~html
+<div id='foo'>Hello!</div>
+~~~
+
+Haml uses indentation to bring the individual elements to represent the HTML
+structure. A tag's children are indented beneath than the parent tag. Again, a
+closing tag is automatically added. For example:
+
+~~~haml
+%ul
+  %li Salt
+  %li Pepper
+~~~
+
+becomes:
+
+~~~html
+<ul>
+  <li>Salt</li>
+  <li>Pepper</li>
+</ul>
+~~~
+
+You can also put plain text as a child of an element:
+
+~~~haml
+%p
+  Hello,
+  World!
+~~~
+
+It's also possible to embed Ruby code into Haml documents. An equals sign, `=`,
+will output the result of the code. A hyphen, `-`, will run the code but not
+output the result. You can even use control statements like `if` and `while`:
+
+~~~haml
+%p
+  Date/Time:
+  - now = DateTime.now
+  %strong= now
+  - if now > DateTime.parse("December 31, 2006")
+    = "Happy new " + "year!"
+~~~
+
+Haml provides far more tools than those presented here. Check out the [reference
+documentation](http://haml.info/docs/yardoc/file.REFERENCE.html)
+for full details.
+
+### Indentation
+
+Haml's indentation can be made up of one or more tabs or spaces. However,
+indentation must be consistent within a given document. Hard tabs and spaces
+can't be mixed, and the same number of tabs or spaces must be used throughout.
+
+## Contributing
+
+Contributions are welcomed, but before you get started please read the
+[guidelines](http://haml.info/development.html#contributing).
+
+After forking and then cloning the repo locally, install Bundler and then use it
+to install the development gem dependencies:
+~~~sh
+gem install bundler
+bundle install
+~~~
+
+Once this is complete, you should be able to run the test suite:
+~~~sh
+rake
+~~~
+
+You'll get a warning that you need to install haml-spec, so run this:
+
+~~~sh
+git submodule update --init
+~~~
+
+At this point `rake` should run without error or warning and you are ready to
+start working on your patch!
+
+Note that you can also run just one test out of the test suite if you're working
+on a specific area:
+
+~~~sh
+ruby -Itest test/helper_test.rb -n test_buffer_access
+~~~
+
+Haml currently supports Ruby 2.0.0 and higher, so please make sure your changes run on 2.0+.
+
+## Team
+
+### Current Maintainers
+
+* [Akira Matsuda](https://github.com/amatsuda)
+* [Matt Wildig](https://github.com/mattwildig)
+* [Tee Parham](https://github.com/teeparham)
+* [Takashi Kokubun](https://github.com/k0kubun)
+
+### Alumni
+
+Haml was created by [Hampton Catlin](http://hamptoncatlin.com), the author of
+the original implementation. Hampton is no longer involved in day-to-day coding,
+but still consults on language issues.
+
+[Natalie Weizenbaum](http://nex-3.com) was for many years the primary developer
+and architect of the "modern" Ruby implementation of Haml.
+
+[Norman Clarke](http://github.com/norman) was the primary maintainer of Haml from 2012 to 2016.
+
+## License
+
+Some of Natalie's work on Haml was supported by Unspace Interactive.
+
+Beyond that, the implementation is licensed under the MIT License.
+
+Copyright (c) 2006-2019 Hampton Catlin, Natalie Weizenbaum and the Haml team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.