gazebo 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3caf7eb2b5c292239e33599a497f33f4be01304e
-  data.tar.gz: f50c6437c9004bdc3b1c8c2fa4bb69b214e8a826
+  metadata.gz: d5c14436278d592380d44ffa550c277e34e05eb6
+  data.tar.gz: 1aa58b42e9c3c2899fdccf09ef67cd1c2c05b17e
 SHA512:
-  metadata.gz: 768a61351e7eb4f8edc73d550961d3f7e8d458d6061fc939f2e1d17924ac4406d77dbdb947e7f1c1961c4408c25b044b36bd16da4aed0f3fa341a6f502d47425
-  data.tar.gz: 43c7aaee21973bd6b6d3710dc4555afea40b6f3e7769d0e2902b1447343046c2bbd8bbb8be437075c17b8e69793093571f042ce41e35d3a91093660173b3d792
+  metadata.gz: db0f3948122fe2b822eb1999c78e75daee1aecffb5c9d8b8bb40f38599c25573fa12f26efcef67b6c2db4c1be573a792e9002d6bacad34dc77c905fbf352bb76
+  data.tar.gz: ed32ef2d9818a8a5eb5c26f3d5a45b90e5752e066fb6d8f997d585c3970550b5ce399a4e28dd289b22327c2713b71a83578c2d79f317057808e1b2a7681fdb4f

data/README.md

@@ -1,9 +1,191 @@
 # Gazebo
 
 A light-weight MVC framework inspired by Rails.
+Check out my beat-making app built to demonstrate using this gem.
+[Github](https://github.com/Tassosb/gazebo-demo "Gazebo Github") |
+[Live](http://gazebo-demo.herokuapp.com/ "Live Link")
 
-## ActiveLeopard
-An ORM with many of the features of Rails ActiveRecord at a fraction of the overhead.
+## Installation
 
-## ActionCondor
-A Controller Base Class that is combined with a custom router and asset server to handle requests and build responses.
+`gem install gazebo`
+
+## Project Setup
+
+You will need to create a project directory with the following structure (need to add a `gazebo new` command):
+
+- /app_name
+  - /app
+    - /controllers
+    - /models
+    - /views
+  - /config
+  - /db
+    - /migrations
+
+Add `gazebo ~> '^0.1.4'` to your Gemfile.
+
+Additionally, at the root of the project you will need a file named `config.ru` with the following code:
+
+```
+require 'gazebo'
+
+Gazebo.root = File.expand_path(File.dirname(__FILE__))
+
+run Gazebo.app
+```
+
+## Migrations
+
+Files in `db/migrations/` will be read and executed as raw sql. Specify the order in which the files will be executed by prefixing each filename with a two digit number (01, 02, 03, ...). This is necessary for migrations to work as expected.
+
+`gazebo migrate` runs any new migrations. Migrations are deemed to be new based on the presence of the filename in a 'migrations' table. At the moment there is no command to rollback migrations. Simply add new ones to reverse the changes you made.
+
+```
+#lib/activeleopard/db_connection.rb
+
+def self.run_migration_file(file_name)
+  migration_name = file_name.match(/\w+/).to_s
+
+  return if migration_name.empty? || already_run?(migration_name)
+
+  file = File.join(Gazebo::ROOT, "db/migrations", file_name)
+  migration_sql = File.read(file)
+  execute(migration_sql)
+
+  record_migration!(migration_name)
+end
+```
+
+## Models and ActiveLeopard
+
+Model files should be named the singular version of their associated table name. Add model files in `app/models/`. All model classes need to inherit from ActiveLeopard::Base. Additionally, users need to call `::finalize!` at the end of the model class definition.
+
+### Validations
+
+Gazebo supports presence and uniqueness validators. The ::validates method can be invoked inside of the class definition, accepting a column_name and an options hash.
+
+Example:
+`validates :name, presence: true, uniqueness: true`
+
+Validations are checked for upon saving. If any validations fail, `#save` will return false. Additionally, the errors will be accessible with the `#errors` method and can be displayed by `#show_errors`.
+
+### Associations
+
+All association creators use sensible defaults generated based on the model class name when explicit primary keys or class names are not given.
+
+`::belongs_to(association_name, options)`
+example: `belongs_to :human, foreign_key: :owner_id`
+
+`::has_many(association_name, options)`
+example: `has_many :cats, :foreign_key => :owner_id`
+
+`has_many_through(association_name, options)`
+example: `has_many_through :cats, :humans, :cats`
+
+`has_one_through(association_name, options)`
+
+### ActiveLeopard Query Methods
+
+The following query methods are available after inheriting from ActiveLeopard::Base. They return Relation objects and can be chained on to each other. The query that is built is only triggered when the actually query result is needed. Relation objects have access to the Enumerables module.
+
+- `::all`
+
+- `::joins(association symbol or string)`
+- `::select(string)`
+- `::group(string)`
+- `::limit(number)`
+- `::from(string)`
+- `::order(string)`
+- `::where(string or hash)`
+
+```
+#lib/activeleopard/modules/searchable.rb
+
+def where(*params)
+  Relation.new(
+    {where: WhereClause.new(params)},
+    self
+    )
+end
+```
+- `::distinct`
+
+The Relation object holds onto the query parameters inside of the `query` instance variable. Before executing the query, or when requested by the user for debugging, the Relation object calls `#as_sql` on each of the clause objects inside of the query hash to construct the sql query.
+```
+#lib/activeleopard/relation.rb
+
+def as_sql
+  Relation.ordered_clauses.map do |clause|
+    query[clause].as_sql
+  end.join(" \n ")
+end
+```
+
+Rather than returning a relation object, the following methods return the found records as object(s).
+
+- `::first`
+- `::last`
+- `::find(id)`
+- `::find_by(string or hash)`
+
+### CRUD Methods
+
+- `::new(params_hash)`
+- `save` ( returns true or false )
+- `#valid?`
+- `#destroy`
+- `::destroy_all`
+
+### Lifecycle Callback Methods
+
+- `::after_initialize(callback_method)` (callback method is invoked in last line of initialize)
+
+## Seeding
+
+Add a `seeds.rb` in /db. You will have access to all the model classes you've defined when you run `bundle exec rake db:seed`.
+
+## Routes
+
+Routes can be defined in `config/routes.rb`. You will need to make this file yourself. Define routes within a block passed to the `Gazebo::Router.draw` method. You need to write out the path as a regular expression, as the router will use regular expression to match wildcards in the path.
+
+Example:
+```
+Gazebo::Router.draw do
+  get Regexp.new("^/beats"), BeatsController, :index
+  delete Regexp.new("^/beats/(?<id>\\d+)$"), BeatsController, :destroy
+end
+```
+
+With the second route, any number after '/beats' will show up in params under a key of 'id'.
+
+## Controllers and ActionCondor
+
+Controller file names should be the constantized form of the folder names in '/views'. Otherwise, ActionCondor will not be able to guess which template to render by default.
+
+### Session
+
+`#session` exposes a Session object which provides an interface for setting keys in an application session cookie. This could be used to implement a basic auth pattern.
+
+### CSRF Protection
+
+When `::protect_from_forgery` is invoked inside of a controller class definition, any non-get requests will be denied unless they carry the correct authenticity_token. authenticity_token can be sent up in forms by including a hidden input with the value given by `#form_authenticity_token`.
+
+### Rendering and Redirecting
+
+The main purpose of the controller base is to build up a response. You can do this easily with the following methods.
+
+Note: a params hash will be populated from wildcards in the url, or data from request. Use `#params` to access this information.
+
+`render(template_name)` (only renders html views at this point)
+
+`redirect_to(url)` (paths relative to project root work fine)
+
+`render_content(content, content_type)` (with this you can render json or text/html)
+
+### Flash
+
+Use `#flash` to expose a flash object. Anything set in the flash object using `[]=` will be available for the current and next req/res cycle. Key value pairs set in `#flash.now` will only be available in the current cycle.
+
+## Serving Static Assets
+
+Place any static assets in `app/assets/`. Most MIME types are supported by the static asset server. You will need to provide the path relative to the root of the project directory. (e.g. `app/assets/images/some_image.jpg`)

data/lib/actioncondor/actioncondor.rb

@@ -2,7 +2,6 @@ require 'active_support'
 require 'active_support/core_ext'
 require 'active_support/inflector'
 require 'erb'
-require 'byebug'
 require 'rack'
 require 'json'
 

data/lib/activeleopard/db_connection.rb

@@ -29,19 +29,24 @@ class DBConnection
     migrations.sort_by! { |fname| Integer(fname[0..1]) }
 
     migrations.each do |file_name|
-      migration_name = file_name.match(/\w+/).to_s
+      run_migration_file(file_name)
+    end
+  end
 
-      next if migration_name.empty? || already_run?(migration_name)
+  private
 
-      file = File.join(Gazebo::ROOT, "db/migrations", file_name)
-      migration_sql = File.read(file)
-      execute(migration_sql)
+  def self.run_migration_file(file_name)
+    migration_name = file_name.match(/\w+/).to_s
 
-      record_migration!(migration_name)
-    end
+    return if migration_name.empty? || already_run?(migration_name)
+
+    file = File.join(Gazebo::ROOT, "db/migrations", file_name)
+    migration_sql = File.read(file)
+    execute(migration_sql)
+
+    record_migration!(migration_name)
   end
 
-  private
   def self.database_name
     Gazebo::ROOT.split('/').last.gsub("-", "_") + '_development'
   end

data/lib/gazebo.rb

@@ -1,4 +1,3 @@
-require 'byebug'
 require 'rack'
 require 'uri'
 
@@ -12,7 +11,7 @@ require_relative 'cli'
 
 module Gazebo
   Router = Router.new
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 
   def self.app
     fetch_routes

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gazebo
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Tassos Bareiss