puffs 0.2.03 → 0.2.04

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed275034578496f20029ea6333fca51a1abc47fa
-  data.tar.gz: 81753c5514e45f504f68772cc0e3472c02e738fd
+  metadata.gz: 62f1bbad581f546893650f943280678b704a8e61
+  data.tar.gz: 3820cd8108d253066d339e762628ca37545b1599
 SHA512:
-  metadata.gz: 63fe1fac7ba793daf239293342504cdd27f82bf789cbb578d0a1d8a15b9f7cab4e1893c3135e030cbb5b21ea3aa89f3156e59d810c6d73135001e900247719df
-  data.tar.gz: 60eabbfc6f95889a9b9bff8cb129797e7a97d4aee97a39f6393cc11645443fd549c9217887059bf010dbc122891042d8e6cf19d4ba3f601a1941fae6fe8d4029
+  metadata.gz: 39b03317cdd9fc533a8212786cde172eb66d0a512adfb32c1723dfa4ea58b21d0aa752bc0d88a5460b4509d9d45d55c98ae9729032018c96488ea6731c9c107e
+  data.tar.gz: 5f15695eb605caf6a1ff4ed2454d8d01d571a912e073528e0c98feddb52bc8b88e9af3df9a94fdc789048eae8ee7e2c8f651f5b241c2c6e135b87aaf41acbcb9

data/SamplePuffsApp/app/controllers/posts.rb

@@ -4,7 +4,7 @@ class PostsController < Puffs::ControllerBase
   end
 
   def create
-    @post = Post.new(body: params['post']['body'], author_id: 6).save
+    @post = Post.new(body: params['post']['body'], author_id: 1).save
     redirect_to ('/posts')
   end
 

data/bin/puffs

@@ -99,6 +99,12 @@ class CLI < Thor
   desc 'new', 'creates a new Puffs app'
   def new(name)
     Dir.mkdir "./#{name}"
+    Dir.mkdir "./#{name}/config"
+
+    File.open("./#{name}/config/database.yml", "w") do |f|
+      f.write("database: #{name}")
+    end
+    
     Dir.mkdir "./#{name}/app"
     Dir.mkdir "./#{name}/app/models"
     Dir.mkdir "./#{name}/app/views"
@@ -106,7 +112,6 @@ class CLI < Thor
     File.open("./#{name}/app/controllers/application_controller.rb", "w") do |f|
       f.write File.read(File.expand_path('../../template/app/controllers/application_controller.rb', __FILE__))
     end
-    Dir.mkdir "./#{name}/config"
     File.open("./#{name}/config/routes.rb", "w") do |f|
       f.write File.read(File.expand_path('../../template/config/routes.rb', __FILE__))
     end

data/lib/db_connection.rb

@@ -1,18 +1,22 @@
 require 'pg'
+require 'yaml'
 
-APP_NAME = "Puffs"
 PRINT_QUERIES = ENV['PRINT_QUERIES'] == 'true'
 MIGRATIONS = Dir.glob('./db/migrate/*.sql').to_a
 
 class DBConnection
+  def self.app_name
+    YAML.load_file(Dir.pwd + '/config/database.yml')['database']
+  end
+
   def self.open
-    @db = PG::Connection.new( :dbname => APP_NAME, :port => 5432 )
+    @db = PG::Connection.new( :dbname => DBConnection.app_name, :port => 5432 )
   end
 
   def self.reset
     commands = [
-      "dropdb #{APP_NAME}",
-      "createdb #{APP_NAME}",
+      "dropdb #{DBConnection.app_name}",
+      "createdb #{DBConnection.app_name}"
     ]
 
     commands.each { |command| `#{command}` }
@@ -22,7 +26,7 @@ class DBConnection
     ensure_version_table
     to_migrate = MIGRATIONS.reject { |file| has_migrated?(file) }
     to_migrate.each { |file| add_to_version(file) }
-    to_migrate.map {|file| "psql -d #{APP_NAME} -a -f #{file}"}
+    to_migrate.map {|file| "psql -d #{DBConnection.app_name} -a -f #{file}"}
               .each {|command| `#{command}`}
   end
 

data/lib/sql_object/associatable.rb

@@ -28,8 +28,6 @@ class HasManyOptions < AssocOptions
   def initialize(name, self_class_name, options = {})
     @primary_key = options[:primary_key] || :id
     @foreign_key = options[:foreign_key] || "#{self_class_name.to_s.underscore}_id".to_sym
-
-    #I think there is a bug here, investigate.
     @class_name = options[:class_name] || name.to_s.singularize.camelcase
   end
 end

data/puffs.gemspec

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "puffs"
-  spec.version       = "0.2.03"
+  spec.version       = "0.2.04"
   spec.authors       = ["Zachary Moroni"]
   spec.email         = ["zachary.moroni@gmail.com"]
 

data/readme.md

@@ -13,25 +13,28 @@ How To Do Puffs
   * Postgres
 
 1. Open command line, enter the following:
-2. gem install puffs
-3. puffs new [name of your app]
-4. puffs db create
+2. `gem install puffs`
+3. `puffs new [name of your app]``
+4. `puffs db create`
 5. You're all set!
 
+Command Line Interface
+----------------------
+
 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
+* `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
 --------
@@ -44,48 +47,48 @@ 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` 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
+`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,
+`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
+* `#create`
+* `#find`
+* `#all`
+* `#update`
+* `#destroy`
 
 ###Also builds Rails table associations:
-* Belongs to
-* Has many
-* Has one through
-* Has many through
+* `::belongs_to`
+* `::has_many`
+* `::has_one_through`
+* `::has_many_through`
 
-##Puffs::SQLRelation
-Has the basic functionality of ActiveRecord::Relation, allowing us to
+##`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
+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
+  * `::all`
+  * `::where`
+  * `::includes`
+  * `::find`
+  * `::order`
+  * `::limit`
+  * `::count`
+  * `::first`
+  * `::last`
 
 ###Eager loading reduces queries
-* Preload has_many and belongs_to associations by calling SQLObject#includes
+* Preload has_many and belongs_to associations by calling `SQLObject::includes`
   * Lazy and chainable.
   * Reduces your DB queries from (n + 1) to 2.
 
@@ -93,29 +96,41 @@ 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,
+* `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
+* `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
+* `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
+* `puffs db reset` executes all three of the above commands, saving you
   time and energy!
 
-Puffs::ControllerBase
+Migrations
+----------
+
+Entering `puffs generate (or puffs g) migration [migration name]` in the
+command line will create a time-stamped SQL file under db/migrations.
+Write SQL in here to stage changes in the DB (add, drop, or change tables),
+and `puffs db migrate` to implement them.
+
+_*NB:*_ To reverse a migration that has been run, you must generate a new
+migration that undoes the changes. Deleting the original migration will
+do nothing.
+
+`Puffs::ControllerBase`
 ---------------------
 
-The Puffs::ControllerBase connects your models to your routes, allowing
+`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.
+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).
+Access your DB with `Puffs::SQLObject` methods by simply entering
+`require 'puffs'` in Pry (or IRB).

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puffs
 version: !ruby/object:Gem::Version
-  version: 0.2.03
+  version: 0.2.04
 platform: ruby
 authors:
 - Zachary Moroni
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-29 00:00:00.000000000 Z
+date: 2016-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -156,13 +156,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".DS_Store"
-- ".byebug_history"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - SamplePuffsApp/Gemfile
 - SamplePuffsApp/Gemfile.lock

data/.byebug_history

@@ -1,2 +0,0 @@
-c
-

data/Gemfile.lock

@@ -1,65 +0,0 @@
-PATH
-  remote: .
-  specs:
-    puffs (0.2.01)
-      activesupport (~> 4.2.5.1)
-      fileutils (~> 0.7)
-      pg (~> 0.18)
-      pry (~> 0.10.3)
-      rack (~> 1.6.4)
-      thor (~> 0.19)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (4.2.5.1)
-      i18n (~> 0.7)
-      json (~> 1.7, >= 1.7.7)
-      minitest (~> 5.1)
-      thread_safe (~> 0.3, >= 0.3.4)
-      tzinfo (~> 1.1)
-    coderay (1.1.1)
-    diff-lcs (1.2.5)
-    fileutils (0.7)
-      rmagick (>= 2.13.1)
-    i18n (0.7.0)
-    json (1.8.3)
-    method_source (0.8.2)
-    minitest (5.8.4)
-    pg (0.18.4)
-    pry (0.10.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    rack (1.6.4)
-    rake (10.5.0)
-    rmagick (2.15.4)
-    rspec (3.1.0)
-      rspec-core (~> 3.1.0)
-      rspec-expectations (~> 3.1.0)
-      rspec-mocks (~> 3.1.0)
-    rspec-core (3.1.7)
-      rspec-support (~> 3.1.0)
-    rspec-expectations (3.1.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.1.0)
-    rspec-mocks (3.1.3)
-      rspec-support (~> 3.1.0)
-    rspec-support (3.1.2)
-    slop (3.6.0)
-    thor (0.19.1)
-    thread_safe (0.3.5)
-    tzinfo (1.2.2)
-      thread_safe (~> 0.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.11)
-  puffs!
-  rake (~> 10.0)
-  rspec (~> 3.0)
-
-BUNDLED WITH
-   1.11.2