automodel-sqlserver 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: da6778caab75ce70c76ac47800481cb06e93e8b5
+  data.tar.gz: 5b16c56f2a195569b818fe353a489baeafc862da
+SHA512:
+  metadata.gz: 0f5533c643c01671712102512daa355947cfbfd8616baa48c836241c290a9609e4e1154ec50956e0052ba157045a22ccda08824e880a8071f25099f2a6201a7a
+  data.tar.gz: 68db03e12bc8c2cbfea6fdf8095d8213415ba65cf1df68dcffbe69f621f3220eae98957a0295e27631f86f53e4cfa9f35210af9599b24275d98fc930dcb4e831

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/pkg/
+/spec/reports/
+/tmp/
+/true/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,81 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  Include:
+  - "**/*.rake"
+  - "**/Gemfile"
+  - "**/Rakefile"
+  - "**/Capfile"
+  - "**/Berksfile"
+  - "**/Cheffile"
+  Exclude:
+  - "vendor/**/*"
+  - "db/**/*"
+  - "tmp/**/*"
+  - "true/**/*"
+Metrics/ClassLength:
+  Description: Avoid classes longer than 100 lines of code.
+  Enabled: false
+  CountComments: false
+  Max: 100
+Metrics/LineLength:
+  Description: Limit lines to 100 characters.
+  Enabled: false
+  Max: 100
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+Metrics/MethodLength:
+  Description: Avoid methods longer than 10 lines of code.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#short-methods
+  Enabled: false
+  CountComments: false
+  Max: 10
+Metrics/AbcSize:
+  Description: A calculated magnitude based on number of assignments, branches, and conditions.
+  Enabled: false
+  Max: 15
+Metrics/CyclomaticComplexity:
+  Description: A complexity metric that is strongly correlated to the number of test cases needed to validate a method.
+  Enabled: false
+  Max: 6
+Lint/Debugger:
+  Description: Warn in debugger entries
+  Enabled: false
+Style/SymbolArray:
+  Description: Use %i or %I for arrays of symbols.
+  Enabled: false
+Style/RegexpLiteral:
+  Description: Enforces using / or %r around regular expressions.
+  EnforcedStyle: percent_r
+Style/AsciiComments:
+  # Disabling this so we can use non-breaking spaces (' ') in documentation comments, preventing browsers from collapsing multiple spaces in code blocks.
+  Description: This cop checks for non-ascii (non-English) characters in comments.
+  Enabled: false
+Style/NumericLiterals:
+  Description: This cop checks for big numeric literals without _ between groups of digits in them.
+  Enabled: false
+Style/Documentation:
+  Description: Document classes and non-namespace modules.
+  Enabled: false
+Style/ClassAndModuleChildren:
+  Description: Use nested modules/class definitions instead of compact style.
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/EmptyMethod:
+  Enabled: false
+Style/StderrPuts:
+  Enabled: true
+  Exclude:
+    - 'bin/**/*'
+Style/BlockDelimiters:
+  Description: Check for uses of braces or do/end around single line or multi-line blocks.
+  Enabled: true
+  Exclude:
+    - 'spec/**/*.rb'
+Style/RescueModifier:
+  Description: This cop checks for uses of rescue in its modifier form.
+  Enabled: false
+Naming/UncommunicativeMethodParamName:
+  Description: This cop checks method parameter names for how descriptive they are.
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.4.4

data/.travis.yml

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

data/.yardopts

@@ -0,0 +1 @@
+--output-dir=./docs --no-private --markup=markdown --format=html

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in automodel.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,82 @@
+PATH
+  remote: .
+  specs:
+    automodel-sqlserver (0.1.0)
+      activerecord (~> 4.2)
+      activerecord-sqlserver-adapter (~> 4.2.0)
+      tiny_tds (~> 2.1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.2.10)
+      activesupport (= 4.2.10)
+      builder (~> 3.1)
+    activerecord (4.2.10)
+      activemodel (= 4.2.10)
+      activesupport (= 4.2.10)
+      arel (~> 6.0)
+    activerecord-sqlserver-adapter (4.2.18)
+      activerecord (~> 4.2.1)
+    activesupport (4.2.10)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.4)
+    builder (3.2.3)
+    byebug (10.0.2)
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    method_source (0.9.0)
+    minitest (5.11.3)
+    mysql2 (0.5.1)
+    pg (0.21.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    sqlite3 (1.3.13)
+    thread_safe (0.3.6)
+    tiny_tds (2.1.2)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  automodel-sqlserver!
+  bundler (~> 1.16)
+  mysql2 (~> 0.5.1)
+  pg (~> 0.21)
+  pry (~> 0.11)
+  pry-byebug (~> 3.6)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec_junit_formatter (~> 0.3)
+  sqlite3 (~> 1.3.13)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Nestor Custodio
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,225 @@
+# automodel-sqlserver  [![Gem Version](https://badge.fury.io/rb/automodel-sqlserver.svg)](https://badge.fury.io/rb/automodel-sqlserver)
+
+Connecting your Rails application to a database created outside of the Rails environment usually means either spending hours writing up class files for every table, or giving up on using the ActiveRecord query DSL and resigning yourself to building SQL strings and making `execute`/`exec_query` calls.
+
+Are those SQL strings you're building even injection-safe? Hmm... 😟
+
+*With a single command*, **automodel-sqlserver** lets you connect to any database and access all of its tables via the ActiveRecord DSL you've grown to love!
+
+It does this by analyzing the table structures and:
+- automatically defining all of the corresponding model classes
+- declaring column aliases so you can use Railsy names an idioms
+- constructing model relations based on foreign key definitions
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'automodel-sqlserver'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install automodel-sqlserver
+
+
+#### Additional Dependencies
+
+If you are running on Windows and **not** using RubyInstaller, the above steps are all that is needed.
+
+On all other platforms, this gem (and its dependencies) alone are not sufficient to connect to a SQL Server instance: **you will also need to [install FreeTDS on your system](https://github.com/rails-sqlserver/tiny_tds#install) if you haven't already**.
+
+
+## Using Automodel
+
+The following examples all assume a Postgres database with the following tables:
+```sql
+-- Create Table: Authors
+CREATE TABLE public."Authors" (
+  "Author ID" serial  NOT NULL           ,
+  "Name"      varchar NOT NULL DEFAULT '',
+  "Birthday"  date        NULL           ,
+  "Address"   varchar NOT NULL DEFAULT '',
+
+  CONSTRAINT authors__pk PRIMARY KEY ("Author ID")
+) WITH ( OIDS=FALSE );
+
+
+-- Create Table: Publishers
+CREATE TABLE public."Publishers" (
+  "Publisher ID" serial  NOT NULL           ,
+  "Name"         varchar NOT NULL DEFAULT '',
+  "Address"      varchar NOT NULL DEFAULT '',
+  "Website"      varchar NOT NULL DEFAULT '',
+
+  CONSTRAINT publishers__pk PRIMARY KEY ("Publisher ID")
+) WITH ( OIDS=FALSE );
+
+
+-- Create Table: Books
+CREATE TABLE public."Books" (
+  "Book ID"         serial  NOT NULL              ,
+  "Title"           varchar NOT NULL DEFAULT ''   ,
+  "Edition"         int     NOT NULL DEFAULT 1    ,
+  "ISBN Number"     varchar NOT NULL DEFAULT ''   ,
+  "Published On"    date    NOT NULL              ,
+  "Is Out Of Print" bool    NOT NULL DEFAULT FALSE,
+  "Author ID"       bigint  NOT NULL              ,
+  "Publisher ID"    bigint  NOT NULL              ,
+
+  CONSTRAINT books__pk PRIMARY KEY ("Book ID"),
+
+  CONSTRAINT books_authors_fk FOREIGN KEY ("Author ID")
+                              REFERENCES public."Authors"("Author ID"),
+
+  CONSTRAINT books_publishers_fk FOREIGN KEY ("Publisher ID")
+                                 REFERENCES public."Publishers"("Publisher ID")
+) WITH ( OIDS=FALSE );
+```
+
+---
+
+#### Connecting To The External Database
+
+You can provide the connection spec inline ...
+
+```ruby
+automodel adapter:  'postgresql' ,
+          encoding: 'unicode'    ,
+          host:     hostname     ,
+          port:     port_number  ,
+          username: username     ,
+          password: password     ,
+          database: database_name
+```
+
+... or you can use a connection spec defined in "config/database.yml" ...
+
+```yml
+## In "database.yml" ...
+
+## ... (your application's own db connection stuff) ...
+
+
+external_db:
+  adapter:  postgresql
+  pool:     <%= ENV.fetch('RAILS_MAX_THREADS') { 5 } %>
+  timeouts: 5000
+  encoding: unicode
+  host:     name_or_ip
+  port:     port_number
+  username: username
+  password: password
+  database: sample_db
+```
+
+```ruby
+## In "config/puma.rb" or "config/unicorn.rb" ...
+
+automodel :external_db
+```
+
+---
+
+#### Using The Automodel'ed Objects
+
+Connecting via either method above will allow you to issue all of the following expressions, just as
+if these were your own models:
+
+```ruby
+## ISBNs for all non-first-edition books.
+isbn_list = Book.where.not(edition: 1).pluck(:isbn_number)
+
+## Take any book and look up some values.
+book = Book.take
+book.title
+book.out_of_print?
+book.publisher.name
+
+
+## Note that some ActiveRecord constructs surface real table names,
+## which can look awkward in code when working with tables with non-Railsy names:
+## (the uppercase "P" in "Publishers" below makes it look like a class reference)
+Book.joins(:Publishers).where(Publishers: { name: test_value }).all
+```
+
+---
+
+#### Automodel With Namespacing
+
+If you're worried about model name collisions (or just want to keep the global namespace tidy), Automodel can define all of the new model classes under a module.
+
+```ruby
+automodel adapter:   'postgresql' ,
+          encoding:  'unicode'    ,
+          host:      hostname     ,
+          port:      port_number  ,
+          username:  username     ,
+          password:  password     ,
+          database:  database_name,
+          namespace: 'ExternalDB'
+
+## Now you can do everything you'd expect, but the models are namespaced under ExternalDB.
+ExternalDB::Book.find(5)            ## => Book #5
+ExternalDB::Book.take.author.class  ## => ExternalDB::Author
+
+```
+
+---
+
+[Consult the repo docs for the full **automodel-sqlserver** documentation.](http://nestor-custodio.github.io/automodel-sqlserver/top-level-namespace.html#automodel-instance_method)
+
+
+## FAQs
+
+- ##### Do I have to add anything to my Gemfile besides `'automodel-sqlserver'`?
+  Due to the nature of this version of the gem, it is assumed you will want to connect to a SQL Server database, so both **[activerecord-sqlserver-adapter](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter)** and the **[tiny_tds](https://github.com/rails-sqlserver/tiny_tds)** gems are included as dependencies (meaning you don't have to worry about them). Note that these gems alone are not sufficient to connect to a SQL Server instance, however: **you still need to [install FreeTDS on your system](https://github.com/rails-sqlserver/tiny_tds#install) if you haven't already**.
+
+  SQL Server aside, you will need to add the corresponding gems if you want to use connection adapters that are not yet part of your gemset. (e.g. Don't expect to be able to connect to a MySQL database without having added `'mysql2'` to your Gemfile.)
+
+- ##### But what about my application's own models?
+  You can call `automodel` **and** continue to use your application's own models without changing a single line of code.
+
+- ##### Can I Automodel more than one database?
+  Yes! You can Automodel as many databases with as many different adapters as you like. **automodel-sqlserver** takes care of connecting to the various databases and managing their connection pools for you.
+
+- ##### What about model name collisions?
+  If an `automodel` call will result in a class name collision, an Automodel::NameCollisionError is raised *before* any classes are clobbered.
+
+- ##### What if I want custom methods for certain models?
+  You can either monkey-patch your methods onto the applicable Automodel-generated classes once they've been defined, or you can monkey-patch the method onto the connection handler class returned by the `automodel` call itself, which will make it available for all models generated *by that call*.
+
+- ##### What if I'm using ActiveRecord but not Rails?
+  That's no problem at all! The **automodel-sqlserver** gem depends on ActiveRecord -- not Rails. Adding `'automodel-sqlserver'` to your Gemfile (along with any relevant connection adapters, of course) is all you need to make use of the tool in your vanilla-Ruby project. Just be mindful that -- since "config/database.yml" isn't available (as you're not using Rails) -- you'll always need to pass in a full connection spec to your `automodel` calls (as in the very first example, under *"Connecting To The External Database"* above).
+
+
+## Feature Roadmap / Future Development
+
+Additional features/options coming in the future:
+
+- **Naming**: Better generation of Railsy names for `:date`/`:datetime` column types.
+- **Reads**: Support for `#find` on tables with composite primary keys.
+- **Writes**: Better handling of missing `created_at`/`updated_at` columns on record creation/updates.
+- **Traversal**: Support for `has_many` relations (only `belongs_to` is currently supported).
+- **Traversal**: Support for self-referential foreign keys.
+- **Traversal**: Support for multiple relations to the same target model.
+
+
+## Contribution / Development
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nestor-custodio/automodel-sqlserver.
+
+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.
+
+Linting is courtesy of [Rubocop](https://github.com/bbatsov/rubocop) and documentation is built using [Yard](https://yardoc.org/). Neither is included in the Gemspec; you'll need to install these locally (`gem install rubocop yard`) to take advantage.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).