hemp 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0aceb1043398fcbc2ee403ad550539c8647492b6
+  data.tar.gz: 4fb5d9141e880dda3075dc91fdae0c91217e10c7
+SHA512:
+  metadata.gz: f4ceb28170e939e20bfb350b4c4f4224927c2fd2035cc381afad14fbf5411fec91f1d811890e9b2e553f8bcbf5bc9b0517b73cc5d23ff3ff453328d3ad3e6d14
+  data.tar.gz: 30072432e50fdcfebc57ac84c0bd41183380b5f831dd866d6174f13aec2758596eb47e6d3638a5bc4ca3246d550697aa0ea8a79c32e3e7aec6af4f6c4f406777

data/.gitignore

@@ -0,0 +1,19 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.rspec
+/lib/hemp/.DS_store
+/test/coverage
+/*/.DS_Store
+/.byebug_history
+/app
+/db
+/test/integration/.DS_Store
+/test/integration/coverage
+/test/integration/.byebug_history

data/.hound.yml

@@ -0,0 +1,4 @@
+scss:
+  enabled: false
+ruby:
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -0,0 +1,233 @@
+AllCops:
+  Exclude:
+    - "vendor/**/*"
+    - "db/schema.rb"
+  UseCache: false
+Style/CollectionMethods:
+  Description: Preferred collection methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#map-find-select-reduce-size
+  Enabled: true
+  PreferredMethods:
+    collect: map
+    collect!: map!
+    find: detect
+    find_all: select
+    reduce: inject
+Style/DotPosition:
+  Description: Checks the position of the dot in multi-line method calls.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-multi-line-chains
+  Enabled: true
+  EnforcedStyle: trailing
+  SupportedStyles:
+  - leading
+  - trailing
+Style/FileName:
+  Description: Use snake_case for source file names.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#snake-case-files
+  Enabled: false
+  Exclude: []
+Style/GuardClause:
+  Description: Check for conditionals that can be replaced with guard clauses
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-nested-conditionals
+  Enabled: false
+  MinBodyLength: 1
+Style/IfUnlessModifier:
+  Description: Favor modifier if/unless usage when you have a single-line body.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#if-as-a-modifier
+  Enabled: false
+  MaxLineLength: 80
+Style/OptionHash:
+  Description: Don't use option hashes when you can use keyword arguments.
+  Enabled: false
+Style/PercentLiteralDelimiters:
+  Description: Use `%`-literal delimiters consistently
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-literal-braces
+  Enabled: false
+  PreferredDelimiters:
+    "%": "()"
+    "%i": "()"
+    "%q": "()"
+    "%Q": "()"
+    "%r": "{}"
+    "%s": "()"
+    "%w": "()"
+    "%W": "()"
+    "%x": "()"
+Style/PredicateName:
+  Description: Check the names of predicate methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#bool-methods-qmark
+  Enabled: true
+  NamePrefix:
+  - is_
+  - has_
+  - have_
+  NamePrefixBlacklist:
+  - is_
+  Exclude:
+  - spec/**/*
+Style/RaiseArgs:
+  Description: Checks the arguments passed to raise/fail.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#exception-class-messages
+  Enabled: false
+  EnforcedStyle: exploded
+  SupportedStyles:
+  - compact
+  - exploded
+Style/SignalException:
+  Description: Checks for proper usage of fail and raise.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#fail-method
+  Enabled: false
+  EnforcedStyle: semantic
+  SupportedStyles:
+  - only_raise
+  - only_fail
+  - semantic
+Style/SingleLineBlockParams:
+  Description: Enforces the names of some block params.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#reduce-blocks
+  Enabled: false
+  Methods:
+  - reduce:
+    - a
+    - e
+  - inject:
+    - a
+    - e
+Style/SingleLineMethods:
+  Description: Avoid single-line methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-single-line-methods
+  Enabled: false
+  AllowIfMethodIsEmpty: true
+Style/StringLiterals:
+  Description: Checks if uses of quotes match the configured preference.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-string-literals
+  Enabled: true
+  EnforcedStyle: double_quotes
+  SupportedStyles:
+  - single_quotes
+  - double_quotes
+Style/StringLiteralsInInterpolation:
+  Description: Checks if uses of quotes inside expressions in interpolated strings
+    match the configured preference.
+  Enabled: true
+  EnforcedStyle: single_quotes
+  SupportedStyles:
+  - single_quotes
+  - double_quotes
+Style/TrailingComma:
+  Description: Checks for trailing comma in parameter lists and literals.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas
+  Enabled: false
+  EnforcedStyleForMultiline: no_comma
+  SupportedStyles:
+  - comma
+  - no_comma
+Metrics/AbcSize:
+  Description: A calculated magnitude based on number of assignments, branches, and
+    conditions.
+  Enabled: false
+  Max: 15
+Metrics/ClassLength:
+  Description: Avoid classes longer than 100 lines of code.
+  Enabled: false
+  CountComments: false
+  Max: 100
+Metrics/ModuleLength:
+  CountComments: false
+  Max: 100
+  Description: Avoid modules longer than 100 lines of code.
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Description: A complexity metric that is strongly correlated to the number of test
+    cases needed to validate a method.
+  Enabled: false
+  Max: 6
+Metrics/MethodLength:
+  Description: Avoid methods longer than 10 lines of code.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#short-methods
+  Enabled: false
+  CountComments: false
+  Max: 10
+Metrics/ParameterLists:
+  Description: Avoid parameter lists longer than three or four parameters.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#too-many-params
+  Enabled: false
+  Max: 5
+  CountKeywordArgs: true
+Metrics/PerceivedComplexity:
+  Description: A complexity metric geared towards measuring complexity for a human
+    reader.
+  Enabled: false
+  Max: 7
+Lint/AssignmentInCondition:
+  Description: Don't use assignment in conditions.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#safe-assignment-in-condition
+  Enabled: false
+  AllowSafeAssignment: true
+Style/InlineComment:
+  Description: Avoid inline comments.
+  Enabled: false
+Style/AccessorMethodName:
+  Description: Check the naming of accessor methods for get_/set_.
+  Enabled: false
+Style/Alias:
+  Description: Use alias_method instead of alias.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#alias-method
+  Enabled: false
+Style/Documentation:
+  Description: Document classes and non-namespace modules.
+  Enabled: false
+Style/DoubleNegation:
+  Description: Checks for uses of double negation (!!).
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-bang-bang
+  Enabled: false
+Style/EachWithObject:
+  Description: Prefer `each_with_object` over `inject` or `reduce`.
+  Enabled: false
+Style/EmptyLiteral:
+  Description: Prefer literals to Array.new/Hash.new/String.new.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#literal-array-hash
+  Enabled: false
+Style/ModuleFunction:
+  Description: Checks for usage of `extend self` in modules.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#module-function
+  Enabled: false
+Style/OneLineConditional:
+  Description: Favor the ternary operator(?:) over if/then/else/end constructs.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#ternary-operator
+  Enabled: false
+Style/PerlBackrefs:
+  Description: Avoid Perl-style regex back references.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-perl-regexp-last-matchers
+  Enabled: false
+Style/Send:
+  Description: Prefer `Object#__send__` or `Object#public_send` to `send`, as `send`
+    may overlap with existing methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#prefer-public-send
+  Enabled: false
+Style/SpecialGlobalVars:
+  Description: Avoid Perl-style global variables.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-cryptic-perlisms
+  Enabled: false
+Style/VariableInterpolation:
+  Description: Don't interpolate global, instance and class variables directly in
+    strings.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#curlies-interpolate
+  Enabled: false
+Style/WhenThen:
+  Description: Use when x then ... for one-line cases.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#one-line-cases
+  Enabled: false
+Lint/EachWithObjectArgument:
+  Description: Check for immutable argument given to each_with_object.
+  Enabled: true
+Lint/HandleExceptions:
+  Description: Don't suppress exception.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#dont-hide-exceptions
+  Enabled: false
+Lint/LiteralInCondition:
+  Description: Checks of literals used in conditions.
+  Enabled: false
+Lint/LiteralInInterpolation:
+  Description: Checks for literals used in interpolation.
+  Enabled: false

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in hemp.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Oduah Tobi
+
+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,256 @@
+# Hemp
+[![Build Status](https://semaphoreci.com/api/v1/projects/3124863c-96d9-4e13-933a-23ef8ea0b600/663694/badge.svg)](https://semaphoreci.com/tobi-oduah/hemp-web-framework) [![Code Climate](https://codeclimate.com/github/andela-toduah/hemp-web-framework/badges/gpa.svg)](https://codeclimate.com/github/andela-toduah/hemp-web-framework) [![Test Coverage](https://codeclimate.com/github/andela-toduah/hemp-web-framework/badges/coverage.svg)](https://codeclimate.com/github/andela-toduah/hemp-web-framework/coverage)
+
+Hemp is a minimalistic web framework designed to understand better, how the Rails web framework works. As with Rails, Hemp is built using Ruby and follows the  Model-View-Controller design pattern. Hemp framework comes with a whittled-down ORM similar to the ActiveRecord design.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hemp'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hemp
+
+## Usage
+
+Hemp, like Rails is modeled with the MVC design framework in mind. Therefore, folder structures are very similar. Models, Views, Controllers are organized in respective folders under the app directory.
+
+To learn more about the MVC design pattern, see https://en.wikipedia.org/wiki/Model-view-controller
+
+```
+hemp_project
+│   
+└───app
+|   └───assets
+|   └───controllers
+|   └───models
+|   └───views
+└───config
+|    └─── routes.rb
+|    └───application.rb
+└───db
+|    └───development.sqlite3
+└───config.ru
+```
+
+Database storage is persisted using the SQLite3 database engine, which is the only supported database engine currently.
+To view a sample web app implemeted with the Hemp framework, see https://github.com/andela-toduah/hemp_todo
+
+## Initial Setup
+The Hemp framework is built on top of Rack - a simple interface between webservers that support Ruby and Ruby frameworks. Thus, web apps built with the framework are initialized same way Rack apps are initlialized. Through a `config.ru` file, which is parsed to determine appropriate configuration settings. A sample `config.ru` is:
+
+```ruby
+require "hemp"
+RACK_ROOT = __dir__
+
+module HempTodo
+  class Application < Hemp::Application
+  end
+end
+
+TodoApplication = HempTodo::Application.new
+
+TodoApplication.pot.prepare do
+  resources :fellows
+  get "/", to: "fellows#index"
+end
+
+Hemp::Dependencies.load_files
+
+use Rack::Static, urls: ["/css", "/images"], root: "app/assets"
+use Rack::MethodOverride
+run TodoApplication
+
+```
+
+The first line of the sample config file requires the Hemp framework. 
+
+The second line sets a congstant used by the framework in searching for important files. This is required in order to map locations of important components in the web application. Thus it should be set by apps built on top of Hemp.  
+
+A sample Application class which inherits from the BaseApplication class provided by Hemp is then declared and initialized. This sample class is used to start up the web server, and inherits methods from the BaseApplication class to provide a rack-compatible response to requests. The declaration for the Application class could be moved into a separate class and then required in the config file.
+
+On instantiating the Application class, routes need to be set. This is done in line 11 of the config file. A block with the route methods called appropriately is passed to the prepare method exposed by the application. This block is evaluated, and routes are saved for processing. The declaration for the routes could be moved into a separate class and then required in the config file.
+
+On evaluating routes, required files need to be loaded. This is done by calling the `load_files` method of the Dependencies module, provided by Hemp. This loads current controllers/models, and adds the path to these folders to the `LOAD_PATH`.
+
+On the last line of the config file, the application is passed to the run method, which is evaluated by Rack to start up the web application on the default port - 9292.
+
+## Key Features
+
+### Routing
+Routing with Hemp deals with directing requests to the appropriate controllers. A sample route file is: 
+
+```ruby
+TodoApplication.pot.prepare do
+  get "/", to: "fellows#index"
+  get "/login", to: "sessions#login"
+  post "/login", to: "sessions#create"
+  resources :fellows
+end
+```
+
+Hemp supports GET, DELETE, PATCH, POST, PUT requests. 
+
+In the sample config file, the second line indicates that GET requests to the root path of the application should be handled by the `index action of the FellowsController`.
+
+Thus an appropriate view named index.html.erb in the fellows folder is expected in the views folder. Instance variables set in the index action of the controller are passed to the Erubis template engine which renders the view.
+
+Resources creates a REST-compatible set of routes which handles CRUD requests dealing with fellows. The declaration is equivalent to writing these set of routes:
+
+```ruby
+get "/fellows", to: "fellows#index"
+get "/fellows/new", to: "fellows#new"
+post "/fellows", to: "fellows#create"
+get "/fellows/:id", to: "fellows#show"
+get "/fellows/:id/edit", to: "fellows#edit"
+patch "/fellows/:id", to: "fellows#update"
+put "/fellows/:id", to: "fellows#update"
+delete "/fellows/:id", to: "fellows#destroy"
+```
+
+
+### Models
+All models to be used with the Hemp framework are to inherit from the BaseRecord class provided by Hemp, in order to access the rich ORM functionalities provided. Although not as succinct as ActiveRecord, the BaseRecord class acts as an interface between the model class and its database representation. A sample model file is provided below:
+
+```ruby
+class Fellow < Hemp::BaseRecord
+  to_table :fellows
+  property :id, type: :integer, primary_key: true
+  property :first_name, type: :text, nullable: false
+  property :email, type: :boolean, nullable: false
+
+  create_table
+end
+```
+The `to_table` method provided stores the table name used while creating the table record in the database. 
+
+The `property` method is provided to declare table columns, and their attributes. The first argument to `property` is the column name, while subsequent hash arguments are used to provide information about attributes.
+
+The `type` argument represents the data type of the column. Supported data types by Hemp are:
+
+  * integer (for numeric values)
+  * boolean (for boolean values [true or false])
+  * text    (for alphanumeric values)
+
+The `primary_key` argument is used to specify that the column should be used as the primary key of the table. If this is an integer, the value is auto-incremented by the database.
+
+The `nullable` argument is used to specify whether a column should have null values, or not.
+
+While creating models, the id property declaration is optional. If this is is not provided, the Hemp ORM adds it automatically, and sets it as the primary key. Thus, it should only be set if you'd like to use a different type as the primary key.
+
+On passing in the table name, and its properties, a call should be made to the `create_table` method to persist the model to database by creating the table.
+
+
+### Controllers
+Controllers are key to the MVC structure, as they handle receiving requests, interacting with the database, and providing responses. Controllers are placed in the controllers folder, which is nested in the app folder.
+
+All controllers should inherit from the BaseController class provided by Hemp to inherit methods which simplify accessing request parameters and returning responses by rendering views.
+
+A sample structure for a controller file is:
+
+```ruby
+class FellowsController < Hemp::BaseController
+  def index
+    @fellows = Fellow.all
+  end
+
+  def new
+  end
+
+  def show
+    fellow
+    render :show_full
+  end
+
+  def destroy
+    fellow.destroy
+    redirect_to "/"
+  end
+end
+```
+
+Instance variables set by the controllers are passed to the routes while rendering responses. 
+
+Explicitly calling `render` to render template files is optional. If it's not called by the controller action, then it's done automatically by the framework with an argument that's the same name as the action. Thus, you can decide to call `render` explicitly when you want to render a view with a name different from the action.
+
+
+### Views
+Currently, view templates are handled through the Tilt gem, with the Erubis template engine. See https://github.com/rtomayko/tilt for more details.
+
+Views are mapped to actions in controllers. Thus the folder structure for storing views depends on the location of the controller/action. A view to be rendered for the new action in the SessionsController for example is saved as `new.html.erb` in the sessions folder, nested in the views folder. A sample structure for a view file is:
+
+```erb
+<div class="big-line-break"></div>
+  <div class="fellow-list">
+    <div class="container">
+      <div class="row">
+        <div class="col l3">&nbsp;</div>
+        <div class="col l5">
+          <form method="POST">
+            <input type="text" class="white-text" name="first_name" value=<%= fellow.first_name %> />
+            <input type="text" class="white-text" name="last_name" value=<%= fellow.last_name %> />
+            <input type="text" class="white-text" name="email" value=<%= fellow.email %> />
+            <input type="text" class="white-text" name="stack" value=<%= fellow.stack %> />
+            <input name="_method" type="hidden" value="put" />
+            <input type="submit" class="btn right" value="Update Fellow"/>
+          </form>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>
+```
+
+### External Dependencies
+The Hemp framework has a few dependencies. These are listed below, with links to source pages for each.
+
+  * sqlite3     - https://github.com/sparklemotion/sqlite3-ruby
+  * erubis      - https://rubygems.org/gems/erubis
+  * bundler     - https://github.com/bundler/bundler
+  * rake        - https://github.com/ruby/rake
+  * rack        - https://github.com/rack/rack
+  * rack-test   - https://github.com/brynary/rack-test
+  * facets      - https://github.com/rubyworks/facets
+  * minitest    - https://github.com/seattlerb/minitest
+  * tilt        - https://github.com/rtomayko/tilt
+
+## Testing
+
+Before running tests, run the following command to install dependencies
+
+        $ bundle install
+
+To test the web framework, run the following command to carry out all tests:
+
+        $ bundle exec rake
+
+## Contributing
+
+1. Fork it by visiting - https://github.com/andela-toduah/hemp-web-framework/fork
+
+2. Create your feature branch
+
+        $ git checkout -b new_feature
+    
+3. Contribute to code
+
+4. Commit changes made
+
+        $ git commit -a -m 'descriptive_message_about_change'
+    
+5. Push to branch created
+
+        $ git push origin new_feature
+    
+6. Then, create a new Pull Request
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+