Qwerty

Add Ons

Several add-ons are available that adjust the project structure to add support for things like i18n, code metrics, Heroku, etc. Run hoboken from the command line for a complete list as help.

Getting Started

Run the bundle command:

bundle install

After you bundle Gemfile, you need to run the generator:

thor section Draw

Replace Draw with the class name.

The generator will create a new section class. The above code will put the following line into lib/qwerty/draw.rb:

# lib/qwerty/draw.rb
require "ruote"

module Qwerty
  class Draw < Ruote::Participant
    def on_workitem
      workitem.fields['draw'] = {
        :key => 'value'
      }
      reply # Work done, let flow resume
    end
  end
end

Adds a section to app.rb directly after the conveyor block.

section(:draw)

We can see that by invoking the description of this new generator:

thor help section 

Usage:
  thor section NAME

Options:
  -s, [--subclass=SUBCLASS]
      [--test-framework=TEST_FRAMEWORK]
                                         # Default: test_unit

--subclass=SUBCLASS - Specify an subclass for this section. If you wish to use this option the recommended command is as follows

thor section Draw --subclass Image

Places a file into lib which contains the specified code.

# lib/qwerty/image/draw.rb
require "ruote"

module Qwerty
	class Image
	  class Draw < Ruote::Participant
	    def on_workitem
	      workitem.fields['image']['draw'] = {
	        :key => 'value'
	      }
	      reply # Work done, let flow resume
	    end
	  end
	end
end

Injects a block of code into /app.rb

section(:image) do
  action(:draw)
end

Start the development server: rake server

Project Layout

.
├── Gemfile
├── Gemfile.lock
├── README.md
├── Rakefile
├── app.rb
├── config.ru
├── config.yml
├── gitignore
├── lib
│   ├── qwerty
│   │   ├── classifier
│   │   │   ├── bayes.rb
│   │   │   ├── lda.rb
│   │   │   ├── ots.rb
│   │   │   └── train_classifier.rb
│   │   ├── classifier.rb
│   │   ├── text
│   │   │   └── quran.rb
│   │   ├── text.rb
│   │   ├── trans
│   │   │   ├── ar_jalalayn.json
│   │   │   ├── en_sahih.json
│   │   │   └── sq_ahmeti.json
│   │   └── workflow.rb
│   └── qwerty.rb
├── public
│   ├── css
│   │   ├── bootstrap.min.css
│   │   ├── select2.min.css
│   │   └── styles.css
│   ├── fonts
│   │   ├── glyphicons-halflings-regular.eot
│   │   ├── glyphicons-halflings-regular.svg
│   │   ├── glyphicons-halflings-regular.ttf
│   │   ├── glyphicons-halflings-regular.woff
│   │   └── glyphicons-halflings-regular.woff2
│   ├── img
│   │   ├── favicon.png
│   │   └── sinatra.png
│   └── js
│       ├── app.js
│       ├── bootstrap.min.js
│       └── select2.min.js
├── section.thor
├── templates
│   ├── action.tt
│   └── section.tt
├── test
│   ├── support
│   │   └── rack_test_assertions.rb
│   ├── test_helper.rb
│   └── unit
│       └── app_test.rb
├── trained.dat
└── views
    ├── index.erb
    ├── layout.erb
    ├── partials
    │   ├── _header.erb
    │   └── _section.erb
    └── train_classifier.erb

16 directories, 45 files

Notes / Use

Contributing

Issues / Roadmap

Use GitHub issues for reporting bug and feature requests.

Patches / Pull Requests

• Fork the project.
• Make your feature addition or bug fix.
• Add tests for it. This is important so I don’t break it in a future version unintentionally.
• Commit, do not mess with Rakefile, version, or history (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull).
• Send me a pull request. Bonus points for topic branches.

License

(The MIT License)

Copyright (c) 2015 Korab Hoxha

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.