puffs 0.2.02 → 0.2.03

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a5304fd7d07adcaea292d602ca9e252271354d3e
-  data.tar.gz: 295905d933ddb84776245dda4580fc52bcd5739f
+  metadata.gz: ed275034578496f20029ea6333fca51a1abc47fa
+  data.tar.gz: 81753c5514e45f504f68772cc0e3472c02e738fd
 SHA512:
-  metadata.gz: 81c92671002c89a0958fa8c8c5348f128140b316bdf3970d22e308148230b971b97e47797c0e7cc90b7ff2675c45e7bd9772386cdf440a798a16975d4c26ae35
-  data.tar.gz: c8c929fb1e2d0731590ebde369aa6954032e64858198a1b4a2f43541c3a85b2ee01136baff29fb4d9add247520ecaff61ae58a8f61c14239df26570ac43518c7
+  metadata.gz: 63fe1fac7ba793daf239293342504cdd27f82bf789cbb578d0a1d8a15b9f7cab4e1893c3135e030cbb5b21ea3aa89f3156e59d810c6d73135001e900247719df
+  data.tar.gz: 60eabbfc6f95889a9b9bff8cb129797e7a97d4aee97a39f6393cc11645443fd549c9217887059bf010dbc122891042d8e6cf19d4ba3f601a1941fae6fe8d4029

data/puffs.gemspec

@@ -5,13 +5,13 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "puffs"
-  spec.version       = "0.2.02"
+  spec.version       = "0.2.03"
   spec.authors       = ["Zachary Moroni"]
   spec.email         = ["zachary.moroni@gmail.com"]
 
   spec.summary       = %q{A simple ORM and MVC inspired by Rails.}
-  spec.description   = %q{Coming Soon...}
-  spec.homepage      = "http://github.com/snackzone"
+  spec.description   = %q{Make simple apps the Rails way, but with less overhead.}
+  spec.homepage      = "http://github.com/snackzone/puffs"
   spec.license       = "MIT"
 
   # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or

data/readme.md

@@ -0,0 +1,121 @@
+Puffs
+=====
+
+Puffs is a lightweight MVC with a built-in ORM that allows you to make
+updates to a Postgres database without writing much SQL code. Sounds a
+little like Rails? Well, let's say Puffs was *inspired* by Rails ;).
+
+How To Do Puffs
+---------------
+
+0. Things you need:
+  * Ruby
+  * Postgres
+
+1. Open command line, enter the following:
+2. gem install puffs
+3. puffs new [name of your app]
+4. puffs db create
+5. You're all set!
+
+Enter 'puffs' into the command line with no arguments to see the full
+list of commands, or just read them below:
+
+* puffs new [app name]
+* puffs server
+* puffs generate
+  * model [model name]
+  * controller [controller name]
+  * migration [migration name]
+* puffs db
+  * create
+  * migrate
+  * seed
+  * reset
+
+Demo App
+--------
+
+As you explore this document, you may find it helpful to reference the
+SamplePuffsApp on the puffs Github repo to see how everything connects.
+
+The Puffs ORM
+-------------
+
+Puffs' object relational mapping is inspired by Rails' ActiveRecord.
+It converts tables in a Postgres database into instances of the
+Puffs::SQLObject class.
+
+Puffs::SQLObject is a very lightweight version of ActiveRecord::Base.
+It's a great way to use ActiveRecord::Base's CRUD methods and associations
+without all the extra overhead.
+
+Puff::SQLRelation imitates the behavior of ActiveRecord::Relation,
+making sure no unnecessary queries are made to the DB.
+
+###All of your favorite methods are present, including:
+* Create
+* Find
+* All
+* Update
+* Destroy
+
+###Also builds Rails table associations:
+* Belongs to
+* Has many
+* Has one through
+* Has many through
+
+##Puffs::SQLRelation
+Has the basic functionality of ActiveRecord::Relation, allowing us to
+order and search DB entries with minimal querying.
+
+All methods are lazy and stackable. Queries are only fired when SQLRelation#load
+is called or when the relation is coerced into an Array.
+
+###Methods included:
+  * All
+  * Where
+  * Includes
+  * Find
+  * Order
+  * Limit
+  * Count
+  * First
+  * Last
+
+###Eager loading reduces queries
+* Preload has_many and belongs_to associations by calling SQLObject#includes
+  * Lazy and chainable.
+  * Reduces your DB queries from (n + 1) to 2.
+
+Database
+--------
+
+The Puffs commands prefixed with 'db' interact with the Puffs Postgres database.
+* 'puffs db create' drops any Postgres DB named 'Puffs' and creates a new,
+  empty one.
+* 'puffs db migrate' finds and any SQL files under db/migrate that have not
+  been migrated and copies them into the DB.
+* 'puffs db seed' calls Seed::populate in db/seeds.rb, allowing you
+  to quickly reset your DB to a seed file while in development.
+* 'puffs db reset' executes all three of the above commands, saving you
+  time and energy!
+
+Puffs::ControllerBase
+---------------------
+
+The Puffs::ControllerBase connects your models to your routes, allowing
+access to the DB through html.erb views. It's how Puffs takes over the Web.
+
+Router
+------
+
+Routes live in config/routes.rb. New routes are written using Regex.
+Open a server connection with the 'puffs server' command.
+
+Puffs Console
+-------------
+
+Access your DB with Puffs::SQLObject methods by simply entering
+"require 'puffs'" in Pry (or IRB).

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puffs
 version: !ruby/object:Gem::Version
-  version: 0.2.02
+  version: 0.2.03
 platform: ruby
 authors:
 - Zachary Moroni
@@ -148,7 +148,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Coming Soon...
+description: Make simple apps the Rails way, but with less overhead.
 email:
 - zachary.moroni@gmail.com
 executables:
@@ -191,11 +191,12 @@ files:
 - lib/sql_object/associatable.rb
 - lib/sql_object/sql_object.rb
 - puffs.gemspec
+- readme.md
 - template/Gemfile
 - template/app/controllers/application_controller.rb
 - template/config/routes.rb
 - template/db/seeds.rb
-homepage: http://github.com/snackzone
+homepage: http://github.com/snackzone/puffs
 licenses:
 - MIT
 metadata: