arpry 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 713eb737c63335766be6ccbb0d3ef319ea352dffd5d3cd606c79ac12ad69dafc
-  data.tar.gz: e887dc4bdffecdff5f591fdc6b0b660149c7bf188ac5bb59a30e60c8c8d32708
+  metadata.gz: 2db01731aef25421eaef49a72b1a89d4e36476bcb44841cb957ad6cb9082d2a4
+  data.tar.gz: 4c070847760cb4a1b638b5dbcbf7304cb3e195d2cbbf873fd0b115a659407761
 SHA512:
-  metadata.gz: 81e5d8e3c5badcc837451064dd6acbe10b6beda3f0ad99ee953d7775a19692d1251adb3a971b331fcba88407846502110cfd211466123efac3886bac4e3a530d
-  data.tar.gz: 89dd849304ba6402168881bde1fe32f6f1afc223b7026aad44e6b8e218eba1917f2f6d2f7278dc56abc55589f99418acbe07aa2c55a0776ce1931d6460568ef6
+  metadata.gz: bcd25b8f5f2d61776052019695d0d17a0602806bca913e1f273980d8ded2ab69f859a4129f8018d2d4b39a746593e3ac7813c99d9461983cc2cbc8df8c993671
+  data.tar.gz: 322477d5332c84d396dcae64c980c72052d5c8efb5108019106a1741b1f54eebf0d534f64c94888aa4b6b1ea58285ce66f010c79f0057e06af19c28c65e6dbad

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2018 Masataka Pocke Kuwabara
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -1,8 +1,13 @@
 # Arpry
 
-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/arpry`. To experiment with that code, run `bin/console` for an interactive prompt.
+Pry with Active Record. Without Rails.
 
-TODO: Delete this and the text above, and describe your gem
+## What's this?
+
+Rails Console is a powerful tool for exploring database, but it works only with Rails.
+
+Arpry works like Rails Console without Rails.
+You can get the same experience as Rails Console to explore database with not-Rails project!
 
 ## Installation
 
@@ -22,7 +27,62 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Explore database with `arpry` command.
+
+```bash
+# For sqlite3
+$ arpry /path/to/databasefile.sqlite3
+
+# For postgresql
+$ arpry --adapter postgresql --host localhost --user YOUR_USER_NAME --password YOUR_PASSWORD --database YOUR_DB_NAME
+```
+
+See `arpry --help` for more information of command line options.
+
+
+Arpry defines classes for each table. For example:
+
+```ruby
+[1] pry(Arpry::Namespace)> User.first
+D, [2018-12-31T22:07:45.652956 #8470] DEBUG -- :   Arpry::Namespace::User Load (0.2ms)  SELECT  "users".* FROM "users" ORDER BY "users"."id" ASC LIMIT ?  [["LIMIT", 1]]
+=> #<Arpry::Namespace::User:0x000056057e2404a8 id: 42, name: "pocke">
+```
+
+Arpry defines has_many, belongs_to, and has_many through relations automatically. For example:
+
+```sql
+-- test.sqlite3
+
+-- Schema
+CREATE TABLE articles ( id int primary key not null, title text not null, content text not null);
+CREATE TABLE comments ( id int primary key not null, article_id int not null, content text not null);
+CREATE TABLE tags ( id int primary key not null, name text not null);
+CREATE TABLE article_tags ( id int primary key not null, article_id int not null, tag_id int not null);
+
+-- Data
+INSERT INTO articles(id, title, content) VALUES (1, 'Awesome Article', 'Hello, world!');
+INSERT INTO comments(id, article_id, content) VALUES (1, 1, 'It is fantastic!');
+INSERT INTO tags(id, name) VALUES (1, 'tech'), (2, 'hobby'), (3, 'game');
+INSERT INTO article_tags(id, article_id, tag_id) VALUES (1, 1, 1), (2, 1, 2);
+```
+
+```bash
+$ sqlite3 db < test.sqlite3
+```
+
+```ruby
+$ arpry db
+[1] pry(Arpry::Namespace)> a = Article.first
+D, [2018-12-31T22:27:02.801294 #10176] DEBUG -- :   Arpry::Namespace::Article Load (0.2ms)  SELECT  "articles".* FROM "articles" ORDER BY "articles"."id" ASC LIMIT ?  [["LIMIT", 1]]
+=> #<Arpry::Namespace::Article:0x000055d1066d6fa0 id: 1, title: "Awesome Article", content: "Hello, world!">
+[2] pry(Arpry::Namespace)> a.comments
+D, [2018-12-31T22:27:08.291179 #10176] DEBUG -- :   Arpry::Namespace::Comment Load (0.3ms)  SELECT "comments".* FROM "comments" WHERE "comments"."article_id" = ?  [["article_id", 1]]
+=> [#<Arpry::Namespace::Comment:0x000055d10684cb78 id: 1, article_id: 1, content: "It is fantastic!">]
+[3] pry(Arpry::Namespace)> a.tags
+D, [2018-12-31T22:27:11.505179 #10176] DEBUG -- :   Arpry::Namespace::Tag Load (0.2ms)  SELECT "tags".* FROM "tags" INNER JOIN "article_tags" ON "tags"."id" = "article_tags"."tag_id" WHERE "article_tags"."article_id" = ?  [["article_id", 1]]
+=> [#<Arpry::Namespace::Tag:0x000055d105f6b2c0 id: 1, name: "tech">, #<Arpry::Namespace::Tag:0x000055d105f6b018 id: 2, name: "hobby">]
+```
+
 
 ## Development
 

data/lib/arpry.rb

@@ -1,8 +1,11 @@
 require 'active_record'
 require 'pry'
+require 'logger'
+require 'optparse'
 
 require "arpry/version"
 require 'arpry/cli'
+require 'arpry/logger'
 require 'arpry/application_record'
 
 module Arpry

data/lib/arpry/application_record.rb

@@ -1,4 +1,5 @@
 module Arpry
   class ApplicationRecord < ActiveRecord::Base
+    self.logger = Arpry::Logger.logger
   end
 end

data/lib/arpry/cli.rb

@@ -9,10 +9,7 @@ module Arpry
     def run
       parse_options
 
-      ApplicationRecord.establish_connection(
-        adapter: @adapter,
-        database: @database,
-      )
+      ApplicationRecord.establish_connection(@params)
 
       generate_classes
 
@@ -23,18 +20,65 @@ module Arpry
 
     private
 
-    # TODO
     def parse_options
-      @database = @argv[0]
-      @adapter = 'sqlite3'
+      opt = OptionParser.new
+      opt.on('-a [NAME]', '--adapter [NAME]')
+      opt.on('-h [HOST]', '--host [HOST]')
+      opt.on('-u [NAME]', '--username [NAME]')
+      opt.on('-p [PASSOWRD]', '--password [PASSOWRD]')
+      opt.on('-d [DB]', '--database [DB]')
+      @params = {}
+      args = opt.parse(@argv, into: @params)
+
+      @params[:database] ||= args[0]
+      if File.exist?(@params[:database])
+        @params[:adapter] ||= 'sqlite3'
+      end
     end
 
     def generate_classes
-      ApplicationRecord.connection.tables.each do |table|
+      classes = ApplicationRecord.connection.tables.map do |table|
         Namespace.const_set(table.classify, Class.new(ApplicationRecord) do
           self.table_name = table
         end)
       end
+
+      relations = Array.new(classes.size) do
+        Array.new(classes.size)
+      end
+
+      classes.each.with_index do |klass, idx|
+        klass.columns.each do |col|
+          ref_name = col.name[/\A(.+)(_id|ID)\z/, 1]
+          next unless ref_name
+          ref_klass_idx = classes.find_index {|c| c.table_name == ref_name.singularize || c.table_name == ref_name.pluralize}
+          next unless ref_klass_idx
+
+          relations[idx][ref_klass_idx] = col.name
+        end
+      end
+
+      relations.each.with_index do |row, idx|
+        klass = classes[idx]
+        exists = row.map.with_index.select {|fk, _idx| fk}
+
+        exists.each do |fk, ref_klass_idx|
+          next unless fk
+
+          ref_klass = classes[ref_klass_idx]
+
+          klass.belongs_to ref_klass.table_name.singularize.to_sym, foreign_key: fk
+          ref_klass.has_many klass.table_name.pluralize.to_sym, foreign_key: fk
+        end
+
+        # from -> klass <- to
+        exists.permutation(2).each do |from, to|
+          from_klass = classes[from[1]]
+          to_fk = to[0]
+          to_klass = classes[to[1]]
+          from_klass.has_many to_klass.table_name.pluralize.to_sym, foreign_key: to_fk, through: klass.table_name.pluralize.to_sym
+        end
+      end
     end
   end
 end

data/lib/arpry/logger.rb

@@ -0,0 +1,8 @@
+module Arpry
+  module Logger
+    extend self
+    attr_accessor :logger
+
+    self.logger = ::Logger.new(STDOUT)
+  end
+end

data/lib/arpry/version.rb

@@ -1,3 +1,3 @@
 module Arpry
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: arpry
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Masataka Pocke Kuwabara
@@ -82,6 +82,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - arpry.gemspec
@@ -91,6 +92,7 @@ files:
 - lib/arpry.rb
 - lib/arpry/application_record.rb
 - lib/arpry/cli.rb
+- lib/arpry/logger.rb
 - lib/arpry/version.rb
 homepage: https://github.com/pocke/arpry
 licenses: []