mobb-activerecord 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 97e535192c6d00e1b58c3bd6e4133986a68419894c487d878f2255660f3e5b98
+  data.tar.gz: 4e5de1f724c0db7b6f8157402818d5553ee5301ebd607a30355daaf4d247122e
+SHA512:
+  metadata.gz: 7c367414c5cfca87b0180888e6180d1f1e4a9836ebad93864f59029c7945f38f25d3b1aa2221b87ff892e0ea70e7bdf117beb026171368ee2a7656f6a4261415
+  data.tar.gz: f125319e3a6b1ad737fbcc5a1dbb6a4686456115320e54ebfc4cb2b40e2d47e343120caf161e89b0732d48ef6e260d1bb99c04221578f845c87368f9e99fa73b

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2018 kinoppyd
+
+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,150 @@
+# Mobb ActiveRecord Extension
+
+Extends [Mobb](https://github.com/kinoppyd/mobb) with extension methods and Rake
+tasks for dealing with an SQL database using the
+[ActiveRecord ORM](https://github.com/rails/rails/tree/master/activerecord).
+
+## Setup
+
+Put it in your `Gemfile`, along with the adapter of your database. For
+simplicity, let's assume you're using SQLite:
+
+```ruby
+gem "mobb-activerecord"
+gem "sqlite3"
+gem "rake"
+```
+
+Now require it in your Mobb application, and establish the database
+connection:
+
+```ruby
+# app.rb
+require "mobb/activerecord"
+
+set :database, {adapter: "sqlite3", database: "foo.sqlite3"}
+# or set :database_file, "path/to/database.yml"
+```
+
+If you have a `config/database.yml`, it will automatically be loaded, no need
+to specify it. Also, in production, the `$DATABASE_URL` environment variable
+will automatically be read as the database (if you haven't specified otherwise).
+
+Note that in **modular** Mobb applications you will need to first register
+the extension:
+
+```ruby
+class YourApplication < Mobb::Base
+  register Mobb::ActiveRecordExtension
+end
+```
+
+Now require the rake tasks and your app in your `Rakefile`:
+
+```ruby
+# Rakefile
+require "mobb/activerecord/rake"
+
+namespace :db do
+  task :load_config do
+    require "./app"
+  end
+end
+```
+
+In the Terminal test that it works:
+
+```sh
+$ bundle exec rake -T
+rake db:create            # Create the database from DATABASE_URL or config/database.yml for the current Rails.env (use db:create:all to create all dbs in the config)
+rake db:create_migration  # Create a migration (parameters: NAME, VERSION)
+rake db:drop              # Drops the database using DATABASE_URL or the current Rails.env (use db:drop:all to drop all databases)
+rake db:fixtures:load     # Load fixtures into the current environment's database
+rake db:migrate           # Migrate the database (options: VERSION=x, VERBOSE=false)
+rake db:migrate:status    # Display status of migrations
+rake db:rollback          # Rolls the schema back to the previous version (specify steps w/ STEP=n)
+rake db:schema:dump       # Create a db/schema.rb file that can be portably used against any DB supported by AR
+rake db:schema:load       # Load a schema.rb file into the database
+rake db:seed              # Load the seed data from db/seeds.rb
+rake db:setup             # Create the database, load the schema, and initialize with the seed data (use db:reset to also drop the db first)
+rake db:structure:dump    # Dump the database structure to db/structure.sql
+rake db:version           # Retrieves the current schema version number
+```
+
+And that's it, you're all set :)
+
+## Usage
+
+You can create a migration:
+
+```sh
+$ bundle exec rake db:create_migration NAME=create_users
+```
+
+This will create a migration file in your migrations directory (`./db/migrate`
+by default), ready for editing.
+
+```ruby
+class CreateUsers < ActiveRecord::Migration
+  def change
+    create_table :users do |t|
+      t.string :name
+    end
+  end
+end
+```
+
+Now migrate the database:
+
+```sh
+$ bundle exec rake db:migrate
+```
+
+You can also write models:
+
+```ruby
+class User < ActiveRecord::Base
+  validates_presence_of :name
+end
+```
+
+You can put your models anywhere you want, only remember to require them if
+they're in a separate file, and that they're loaded after `require "mobb/activerecord"`.
+
+Now everything just works:
+
+```ruby
+on 'list users' do
+  users = User.all
+  users.map{ |u| "- #{u.name}"}.join("\n")
+end
+
+on /user (\w+)/ do |name|
+  user = User.find_by(name: name)
+  "#{user.id} : #{user.name}"
+end
+```
+
+A nice thing is that the `ActiveRecord::Base` class is available to
+you through the `database` variable:
+
+```ruby
+if database.table_exists?('users')
+  # Do stuff
+else
+  raise "The table 'users' doesn't exist."
+end
+```
+
+## History
+
+This gem was made in 2009 by Blake Mizerany, creator of Sinatra.
+And forked by Janko Marohnić to improve on.
+
+## Social
+
+You can follow me on Twitter, I'm [@GhostBrain](http://twitter.com/GhostBrain).
+
+## License
+
+[MIT](https://github.com/kinoppyd/mobb-activerecord/blob/master/LICENSE)

data/lib/mobb/activerecord.rb

@@ -0,0 +1,62 @@
+require 'mobb/base'
+require 'active_record'
+require 'active_support/core_ext/hash/keys'
+
+require 'logger'
+require 'pathname'
+require 'yaml'
+require 'erb'
+
+module Mobb
+  module ActiveRecordHelper
+    def database
+      settings.database
+    end
+  end
+
+  module ActiveRecordExtension
+    def self.registered(app)
+      if ENV['DATABASE_URL']
+        app.set :database, ENV['DATABASE_URL']
+      elsif File.exist?("#{Dir.pwd}/config/database.yml")
+        app.set :database_file, "#{Dir.pwd}/config/database.yml"
+      end
+
+      unless defined?(Rake) || [:test, :production].include?(app.settings.environment)
+        ActiveRecord::Base.logger = Logger.new(STDOUT)
+      end
+
+      app.helpers ActiveRecordHelper
+
+      # re-connect if database connection dropped (Rails 3 only)
+      app.before { ActiveRecord::Base.verify_active_connections! if ActiveRecord::Base.respond_to?(:verify_active_connections!) }
+      app.after { ActiveRecord::Base.clear_active_connections! }
+    end
+
+    def database_file=(path)
+      path = File.join(root, path) if Pathname(path).relative? and root
+      spec = YAML.load(ERB.new(File.read(path)).result) || {}
+      set :database, spec
+    end
+
+    def database=(spec)
+      if spec.is_a?(Hash) and spec.symbolize_keys[environment.to_sym]
+        ActiveRecord::Base.configurations = spec.stringify_keys
+        ActiveRecord::Base.establish_connection(environment.to_sym)
+      elsif spec.is_a?(Hash)
+        ActiveRecord::Base.configurations[environment.to_s] = spec.stringify_keys
+        ActiveRecord::Base.establish_connection(spec.stringify_keys)
+      else
+        ActiveRecord::Base.establish_connection(spec)
+        ActiveRecord::Base.configurations ||= {}
+        ActiveRecord::Base.configurations[environment.to_s] = ActiveRecord::ConnectionAdapters::ConnectionSpecification::ConnectionUrlResolver.new(spec).to_hash
+      end
+    end
+
+    def database
+      ActiveRecord::Base
+    end
+  end
+
+  register ActiveRecordExtension
+end

data/lib/mobb/activerecord/rake.rb

@@ -0,0 +1,6 @@
+load "active_record/railties/databases.rake"
+require "mobb/activerecord/rake/activerecord_#{ActiveRecord::VERSION::MAJOR}"
+
+load "mobb/activerecord/tasks.rake"
+
+ActiveRecord::Base.logger = nil

data/lib/mobb/activerecord/rake/activerecord_3.rb

@@ -0,0 +1,31 @@
+require "active_support/string_inquirer"
+
+module Rails
+  extend self
+
+  def root
+    Pathname.new(Rake.application.original_dir)
+  end
+
+  def env
+    ActiveSupport::StringInquirer.new(ENV["REPP_ENV"] || "development")
+  end
+
+  def application
+    seed_loader = Object.new
+    seed_loader.instance_eval do
+      def load_seed
+        load "db/seeds.rb"
+      end
+    end
+    seed_loader
+  end
+end
+
+# db:load_config can be overriden manually
+Rake::Task["db:seed"].enhance(["db:load_config"])
+Rake::Task["db:load_config"].clear
+
+# define Rails' tasks as no-op
+Rake::Task.define_task("db:environment")
+Rake::Task.define_task("db:rails_env")

data/lib/mobb/activerecord/rake/activerecord_4.rb

@@ -0,0 +1,23 @@
+seed_loader = Class.new do
+  def load_seed
+    load "#{ActiveRecord::Tasks::DatabaseTasks.db_dir}/seeds.rb"
+  end
+end
+
+ActiveRecord::Tasks::DatabaseTasks.tap do |config|
+  config.root                   = Rake.application.original_dir
+  config.env                    = ENV["REPP_ENV"] || "development"
+  config.db_dir                 = "db"
+  config.migrations_paths       = ["db/migrate"]
+  config.fixtures_path          = "test/fixtures"
+  config.seed_loader            = seed_loader.new
+  config.database_configuration = ActiveRecord::Base.configurations
+end
+
+# db:load_config can be overriden manually
+Rake::Task["db:seed"].enhance(["db:load_config"])
+Rake::Task["db:load_config"].clear
+
+# define Rails' tasks as no-op
+Rake::Task.define_task("db:environment")
+Rake::Task["db:test:deprecated"].clear if Rake::Task.task_defined?("db:test:deprecated")

data/lib/mobb/activerecord/rake/activerecord_5.rb

@@ -0,0 +1,23 @@
+seed_loader = Class.new do
+  def load_seed
+    load "#{ActiveRecord::Tasks::DatabaseTasks.db_dir}/seeds.rb"
+  end
+end
+
+ActiveRecord::Tasks::DatabaseTasks.tap do |config|
+  config.root                   = Rake.application.original_dir
+  config.env                    = ENV["REPP_ENV"] || "development"
+  config.db_dir                 = "db"
+  config.migrations_paths       = ["db/migrate"]
+  config.fixtures_path          = "test/fixtures"
+  config.seed_loader            = seed_loader.new
+  config.database_configuration = ActiveRecord::Base.configurations
+end
+
+# db:load_config can be overriden manually
+Rake::Task["db:seed"].enhance(["db:load_config"])
+Rake::Task["db:load_config"].clear
+
+# define Rails' tasks as no-op
+Rake::Task.define_task("db:environment")
+Rake::Task["db:test:deprecated"].clear if Rake::Task.task_defined?("db:test:deprecated")

data/lib/mobb/activerecord/tasks.rake

@@ -0,0 +1,52 @@
+require "active_support/core_ext/string/strip"
+require "pathname"
+require "fileutils"
+
+namespace :db do
+  desc "Create a migration (parameters: NAME, VERSION)"
+  task :create_migration do
+    unless ENV["NAME"]
+      puts "No NAME specified. Example usage: `rake db:create_migration NAME=create_users`"
+      exit
+    end
+
+    name    = ENV["NAME"]
+    version = ENV["VERSION"] || Time.now.utc.strftime("%Y%m%d%H%M%S")
+
+    ActiveRecord::Migrator.migrations_paths.each do |directory|
+      next unless File.exist?(directory)
+      migration_files = Pathname(directory).children
+      if duplicate = migration_files.find { |path| path.basename.to_s.include?(name) }
+        puts "Another migration is already named \"#{name}\": #{duplicate}."
+        exit
+      end
+    end
+
+    filename = "#{version}_#{name}.rb"
+    dirname  = ActiveRecord::Migrator.migrations_paths.first
+    path     = File.join(dirname, filename)
+    ar_maj   = ActiveRecord::VERSION::MAJOR
+    ar_min   = ActiveRecord::VERSION::MINOR
+    base     = "ActiveRecord::Migration"
+    base    += "[#{ar_maj}.#{ar_min}]" if ar_maj >= 5
+
+    FileUtils.mkdir_p(dirname)
+    File.write path, <<-MIGRATION.strip_heredoc
+      class #{name.camelize} < #{base}
+        def change
+        end
+      end
+    MIGRATION
+
+    puts path
+  end
+end
+
+# The `db:create` and `db:drop` command won't work with a DATABASE_URL because
+# the `db:load_config` command tries to connect to the DATABASE_URL, which either
+# doesn't exist or isn't able to drop the database. Ignore loading the configs for
+# these tasks if a `DATABASE_URL` is present.
+if ENV.has_key? "DATABASE_URL"
+  Rake::Task["db:create"].prerequisites.delete("load_config")
+  Rake::Task["db:drop"].prerequisites.delete("load_config")
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: mobb-activerecord
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Blake Mizerany
+- Janko Marohnić
+- kinoppyd
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mobb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Extends mobb with ActiveRecord helpers.
+email: WhoIsDissolvedGirl+github@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/mobb/activerecord.rb
+- lib/mobb/activerecord/rake.rb
+- lib/mobb/activerecord/rake/activerecord_3.rb
+- lib/mobb/activerecord/rake/activerecord_4.rb
+- lib/mobb/activerecord/rake/activerecord_5.rb
+- lib/mobb/activerecord/tasks.rake
+homepage: http://github.com/kinoppyd/mobb-activerecord
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Extends mobb with ActiveRecord helpers.
+test_files: []