rails_lite 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7759a770dc9602ef49cb194ca84f76800a38187f0fc77ebd8ab249695064a51e
-  data.tar.gz: c3670509e07359ba58f390ff14ac32481fd6385d3601d958f0431d8973391b18
+  metadata.gz: dbcf381a06732d23f274997af2d2e67977087cb6b59d773189e2ee766684f9dc
+  data.tar.gz: bc3332186e697520dc19a42dc922549222cbe6f7ec0926cd176299eb4ff00d10
 SHA512:
-  metadata.gz: 2add2ce2b42b6d29051dea795cbc08b660e7339fb12e97a0acc48d7587a58a39d0c709d193b8c338424f6f685d44d197a74578a690f951ebf0638736e477a1d1
-  data.tar.gz: 0b5d8c6e7e47507619d1137dd1d0ea98b24c521076f1dd6f46507dd784e8a5998a89b730b183998d84948edf92b77eccac6d70493ccded75916184df490e5a91
+  metadata.gz: 403808d65334e44514bd141b1a0982379425be91252cb36aa3e861ee3afdedb7b36ba611c793198701c573cc91311cca92d5e2186782c011b22935828223d5fb
+  data.tar.gz: ee7286b773cc84d8d532c1fcf809258f8f2c429b2a71226c9c5fb874c197d615bcc5039201dd3c7b52898db1cdea9c99a90f723a3883769364b0291ffb88241c

data/README.md

@@ -1,6 +1,6 @@
 # RailsLite
 
-Lyle is an MVC framework for building web applications. Some features include:
+RailsLite is an MVC framework for building web applications. Some features include:
 
 * SQLite or PostgreSQL ORM with associations and search
 * Controllers with Session and Flash Management
@@ -33,13 +33,229 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Creating a Project
 
-## Development
+To create a new project navigate the directory you would like to create the project and run:
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+    $ railslite new [PROJECT_NAME]
+    
+To start a local server run either:
+
+    $ railslite server
+    $ railslite s
+    
+To open pry for your project run either:
+
+    $ railslite console
+    $ railslite c
+
+### Database
+
+RailsLite's ORM works with SQLite, so you will need to edit the `db/database.sql` file to reflect your schema and include your seeds. Then run:
+
+    $ railslite dbreset
+
+### Routes
+
+Routes go in the `config/routes.rb` file. Routes work exactly like they do in rails. 
+
+```ruby
+root to: 'bands#index'
+
+resource :sessions, only: [:new, :create, :destroy]
+
+resources :users, only: [:show, :new, :create] do
+  member do 
+    get :[CUSTOM_ROUTE]
+  end
+end
+
+resources :bands do
+  collection do
+    get :[CUSTOM_ROUTE]
+  end
+  resources :albums, only: [:new]
+end
+
+resources :albums, except: [:index, :new] do
+  resources :tracks, only: [:new]
+end
+
+resources :tracks, only: [:show, :create, :edit, :update, :destroy,]
+
+resources :notes, only: [:create, :destroy]
+patch '/[CUSTOM_ROUTE]/:id', to: 'notes#[CUSTOM_METHOD]'
+get '/[CUSTOM_ROUTE]', to: 'notes#[CUSTOM_METHOD]'
+```
+
+URL helper methods are created for your routes. To view these methods and all of your routes run:
+
+    $ railslite routes
+    
+### Models
+
+Models go in `app/models` and inherit from ApplicationModel.  You can add methods to ApplicationModel at `app/models/application_model.rb`. Models have access to validations on presence, uniqueness and length, as well as, the lifecyle methods `after_initialize` and `before_validation`. Models also can have `belongs_to`, `has_many` and `has_one` using the same syntax as rails. Creating a `belongs_to` association will automatically create a validation for the presence of the `foreign_key` unless `optional: true` is included.
+
+```ruby
+require 'bcrypt'
+
+class User < ApplicationModel
+  validates :username, presence: true, uniqueness: true
+  validates :password_digest, presence: true
+  validates :password, length: { minimum: 6, allow_nil: true }
+  validates :session_token, presence: true, uniqueness: true
+
+  has_many :notes
+
+  after_initialize :ensure_token
+  
+  attr_reader :password
+  
+  def self.find_by_credentials(username, password)
+    user = User.find_by(username: username)
+    user && user.is_password?(password) ? user : nil
+  end
+  
+  def self.generate_token
+    SecureRandom::urlsafe_base64
+  end
+  
+  def password=(password)
+    @password = password
+    self.password_digest = BCrypt::Password.create(password)
+  end
+  
+  def ensure_token
+    self.session_token ||= User.generate_token
+  end
+  
+  def reset_token!
+    self.session_token = User.generate_token
+    self.save!
+    self.session_token
+  end
+  
+  def is_password?(password)
+    BCrypt::Password.new(self.password_digest).is_password?(password)
+  end
+end
+```
+
+### Controllers
+
+Models go in `app/controllers` and inherit from ApplicationController. You can add methods to ApplicationController at `app/controllers/application_model.rb`. Contoller methods will automatically render their corrosponding view if no render or redirect is specified. Controllers also support strong params and have a `before_action` lifecycle method. Including `protect_from_forgery` in a controller will implement CSRF protection. Include `<input type="hidden" name="authenticity_token" value="<%= form_authenticity_token %>">` in any of your forms when `protect_from_forgery` is enabled.
+
+```ruby
+class BandsController < ApplicationController
+  protect_from_forgery
+  
+  def index
+    @bands = Band.all
+  end
+
+  def show
+    @band = Band.find(params[:id])
+  end
+
+  def new
+    @band = Band.new
+  end
+
+  def create
+    @band = Band.new(band_params)
+
+    if @band.save
+      redirect_to band_url(@band)
+    else
+      flash.now[:errors] = @band.errors
+      render :new
+    end
+  end
+
+  def edit
+    @band = Band.find(params[:id])
+  end
+
+  def update
+    @band = Band.find(params[:id])
+    if @band.update_attributes(band_params)
+      redirect_to band_url(@band)
+    else
+      flash.now[:errors] = @band.errors
+      render :edit
+    end
+  end
+
+  def destroy
+    @band = Band.find(params[:id])
+    @band.destroy
+    redirect_to bands_url
+  end
+
+  def json
+    @bands = Band.all
+  end
+
+  private
+  
+  def band_params
+    params.require(:band).permit(:name)
+  end
+
+  before_action :ensure_login
+end
+
+```
+
+### Views
+
+Create your views at `app/views/[CONTROLLER_NAME]/[ACTION].html.erb` or `app/views/[CONTROLLER_NAME]/[ACTION].json.jbuilder`. Place any code you want shared between all your HTML views in `app/views/application.html.erb`.
+
+```ruby
+<h1 class='page-header'>Bands</h1>
+
+<ul class='main-list'>
+  <% @bands.each do |band| %>
+    <li><a href="<%= band_url(band) %>"><p><%= band.name %></p></a></li>
+  <% end %>
+</ul>
+
+<h4 class='sub-header'>Links</h4>
+<ul class='page-links'>
+  <li><a class='button' href="<%= new_bands_url %>" >New band</a></li>
+</ul>
+```
+```ruby
+Jbuilder.encode do |json|
+  json.array! @bands
+end
+```
+
+### Relation
+
+RailsLite includes a `Relation` class that searches the database with SQL queiries similar to active record.  The Relation methods include:
+
+* `where`
+* `joins`
+* `left_joins`
+* `select`
+* `find_by`
+* `find`
+* `first`
+* `last`
+* `all`
+* `save`
+* `save!`
+* `update`
+* `update_attributes`
+* `destroy`
+
+Relation methods are lazy and stackable.  For example:
+
+```ruby
+User.joins(:bands).where(band_id: 1)
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/lib/rails_lite/version.rb

@@ -1,3 +1,3 @@
 module RailsLite
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/scaffold/app/controllers/bands_controller.rb

@@ -22,7 +22,7 @@ class BandsController < ApplicationController
     if @band.save
       redirect_to band_url(@band)
     else
-      flash.now[:errors] = @band.errors.full_messages
+      flash.now[:errors] = @band.errors
       render :new
     end
   end
@@ -37,7 +37,7 @@ class BandsController < ApplicationController
     if @band.update_attributes(band_params)
       redirect_to band_url(@band)
     else
-      flash.now[:errors] = @band.errors.full_messages
+      flash.now[:errors] = @band.errors
       render :edit
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_lite
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Jeff DeLiso