easy_save 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f86c6567772019207e0b8650c491d018a6f44774
-  data.tar.gz: 8f06b4b6afd654bbfac92d95a8a0d261fddb282a
+  metadata.gz: 43de1c6f3d6cdd41f228e922141992b5375cf85d
+  data.tar.gz: 929b8badc55e6cbcc883a8c1e8a5d45cde780249
 SHA512:
-  metadata.gz: 9292ce9e1d5d99e876e6877897938e15e6def954249df21c5665516b656f9fafcb390b316bc4d04232fc23e064fcf98a729d9aee09ed769890d6d4463a472321
-  data.tar.gz: 76b2da6c75726a84b0df2e86f50bcb00d82df407188505e01b719a56d24de0f6433f86b70d5cf147f519569f65175b1c5666e87756b493a6a7dc19c652a2a908
+  metadata.gz: df6cfb4df7c7b646c67fe1dbf5b7f08028259b348744f1841ecbaa7b96148badb9c74ee193efe98b2746e4122c06b1fdb23af7074a178ff58d2b2fcf385bf02b
+  data.tar.gz: c20cdbf9f16cad339e982af03d562c3c68107cf7b736889c1f43374dd24381828e8292133a775db00e21ba0d772cdd07438a8ee8da8e30f3c683173203e9d5ec

data/README.md

@@ -1,8 +1,7 @@
 # EasySave
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/easy_save`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+EasySave is a lightweight ORM written in Ruby that abstracts away the
+complexities of working with SQL databases. 
 
 ## Installation
 
@@ -22,20 +21,93 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Setting up for your own usage: 
+
+Place your sql file in the root of the project directory, and in
+`lib/easy_save/db_connection.rb` change `'example.sql'` to your sql file's
+name.
+
+```ruby
+#lib/easy_save/db_connection.rb
+USERS_SQL_FILE = File.join(ROOT_FOLDER, 'example.sql')
+USERS_DB_FILE = File.join(ROOT_FOLDER, 'example.db')
+
+```
+
+Once that's done, in each model that is involved in the database, require
+'easy_gem', subclass it from SQLObject and `finalize!` it to create the methods.
+
+```ruby
+require 'easy_gem'
+
+class User < SQLObject
+
+self.finalize!
+end
+```
+
+### Setting up demo: 
+
+A demo database has been included as well, in the example folder.
+
+Run Pry or IRB in the examples folder, and `load 'example.rb'`.
+
+At that point `Users`, `Comments`, `Photos`, and their respective associations can all
+be explored.
+
+#### A step by step guide:
+
+1. Clone the repo.
+2. Open `EasySave/examples` and Pry / IRB in that same folder.
+3. `load 'example.rb'`
+4. Try out different things like User.find(1) or Comment.find(2).
+
+## Features
+
+### Example Methods
+
+Methods will return an instance of the object using the information from
+the database if appropriate.
+
+#### Object methods: 
+
+* `::all`: Returns an array of all the objects from the corresponding table.
+* `::find(id)`: Returns the object corresponding to the row with the ID.
+* `::first`: Returns the first row from that table.
+* `::table_name`: Returns the instance variable of the table name, or creates
+  the table name name and sets the instance variable for future reference.
+* `::table_name=(table_name)`: Takes an argument and sets the table name to
+  that.
+* `#insert`: Inserts the object into it's correponsind table as a new row.
+* `#update`: Updates an objects information in the database.
+* `#save`: Either updates or inserts an entry in the database, depending on if
+  you're already 
+* `#finalize!`: Necessary to create the attribute accessors based on database
+  columns. Called at the end of the class declaration..
 
-## Development
+#### Association methods:
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+* `::belongs_to(name, options)`: Take a model name and an optional options hash
+  and creates a method called `#name`. The method returns the instance of the
+  model name to whose ID matches the foreign key held by the object calling the
+  method.
+* `::has_many(name, options)`: Similar to `#belongs_to` but instead returns
+  instances of the model name whose foreign key matches the ID help by object
+  calling the method.
+* `::has_one_through(name, through_name, source_name)`: Requires three
+  arguments, the name of the target model class, the through name of the
+  intermediary, and the source name of the method in the intermediary. The
+  generated method returns an instance of `#name` whose id matches the foreign
+  key of the `through_name` object whose id matches the foreign key of the
+  `source name` object that is calling the method.
 
-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
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/easy_save. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+## Future Work
 
+1. `has_many_through` associations
+2. Validation check methods
+3. `joins` to perform SQL joins
 
-## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 

data/{example.rb → examples/example.rb}

@@ -1,4 +1,4 @@
-require_relative 'lib/easy_save.rb'
+require_relative '../lib/easy_save'
 
 DBConnection.reset
 
@@ -23,3 +23,19 @@ class Comment < SQLObject
   self.finalize!
 end
 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

data/lib/easy_save/db_connection.rb

@@ -1,5 +1,4 @@
 require 'sqlite3'
-require 'byebug'
 
 PRINT_QUERIES = ENV['PRINT_QUERIES'] == 'true'
 # https://tomafro.net/2010/01/tip-relative-paths-with-file-expand-path
@@ -18,10 +17,9 @@ class DBConnection
   end
 
   def self.reset
-    commands = [
-      "rm '#{USERS_DB_FILE}'",
-      "cat '#{USERS_SQL_FILE}' | sqlite3 '#{USERS_DB_FILE}'"
-    ]
+    commands = []
+    commands << "rm '#{USERS_DB_FILE}'" if File.exist?(USERS_DB_FILE)
+    commands << "cat '#{USERS_SQL_FILE}' | sqlite3 '#{USERS_DB_FILE}'"
 
     commands.each { |command| `#{command}` }
     DBConnection.open(USERS_DB_FILE)

data/lib/easy_save/version.rb

@@ -1,3 +1,3 @@
 module EasySave
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_save
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Akshith Yellapragada
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-02 00:00:00.000000000 Z
+date: 2017-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -88,8 +88,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".rspec"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -98,8 +96,8 @@ files:
 - bin/console
 - bin/setup
 - easy_save.gemspec
-- example.rb
-- example.sql
+- examples/example.rb
+- examples/example.sql
 - lib/easy_save.rb
 - lib/easy_save/associatable.rb
 - lib/easy_save/db_connection.rb

data/.rspec

@@ -1,2 +0,0 @@
---format documentation
---color

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.3.1
-before_install: gem install bundler -v 1.14.6