hanami-sequel 1.1.0.1

data/README.md

@@ -0,0 +1,129 @@
+# Hanami::Sequel
+
+This gem is designed to replace the `hanami-model` one in your
+[Hanami](https://hanamirb.org/) project. It adds an equivalent set of database
+commands to the `hanami` executable, and generates Sequel models.
+
+Please note that using this gem could be considered bad practice with regards
+to Hanami's architectural goals, as it does not provide any help to separate
+the model into entities and repositories. On the other hand, it does nothing to
+prevent it either.
+
+## Installation
+
+Follow the instructions for removing `hanami-model`:
+[Use Your Own ORM](http://hanamirb.org/guides/1.1/models/use-your-own-orm/)
+
+Add this line to your `config/environment.rb`:
+
+```ruby
+require "hamani/sequel/model"
+```
+
+Add this line to your application's Gemfile (adding the gem to the `plugins`
+group ensures that the `hanami` executable is correctly extended):
+
+```ruby
+group :plugins do
+  gem 'hanami-sequel', '~> 1.1.0'
+end
+```
+
+And then execute:
+
+    $ bundle
+
+## Versioning
+
+This gem's version is based on the major and minor versions of Hanami. For
+`hanami-X.Y.Z`, use `hanami-sequel-X.Y.P`. This gem's patch version (denoted as
+`P`) is independent from Hanami's patch version (denoted as `Z`).
+
+## Configuration
+
+As of now, the paths to migrations and models are hardcoded respectively to
+`db/migrations/` and `lib/#{project_name}/models/`.
+
+## Usage
+
+All the commands start with the `sequel` argument:
+
+```text
+Commands:
+  hanami sequel create
+  hanami sequel drop
+  hanami sequel install
+  hanami sequel migrate [VERSION]
+  hanami sequel migration NAME
+  hanami sequel model NAME
+  hanami sequel seed
+```
+
+#### Create a database table
+
+    $ hanami sequel model NAME
+
+Where `NAME` is the name of the model. This creates a database migration, a
+Sequel model and a spec file.
+
+#### Create a database migration
+
+    $ hanami sequel migration NAME
+
+Where `NAME` is an arbitrary name.
+
+#### Create the database
+
+    $ hanami sequel create
+
+This command will fail in the `production` environment.
+
+#### Migrate the database
+
+    $ hanami sequel migrate [VERSION]
+
+Where `VERSION` can be:
+
+* "up" (default value), to do all the migrations, i.e. `hanami sequel migrate`
+  or `hanami sequel migrate up`.
+* "down", to undo all the migrations, i.e. `hanami sequel migrate down`.
+* a timestamp, representing the first part of the target migration file. E.g.
+  `hanami sequel migrate 20180201153930` to migrate to the database version as
+  of 1st February 2018 at 15:39:30 (if a migration file starting with this
+  value is found).
+
+#### Seed the database
+
+    $ hanami sequel seed
+
+This command will look up your models for `Hanami:Sequel:Seed` class methods
+used to import constants into your tables. If an error occurs, the whole `seed`
+operation will be rolled back.
+
+#### Drop the database
+
+    $ hanami sequel drop
+
+This command will fail in the `production` environment.
+
+#### Install the database
+
+    $ hanami sequel install
+
+This command `drop`s, `create`s, `migrate`s, then `seed`s your database. It will fail in
+the `production` environment.
+
+## Development
+
+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.
+
+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).
+
+## Known issues / To-do list
+
+* hardcoded configuration values
+* no tests
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/malin-as/hanami-sequel.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hanami/sequel"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/hanami-sequel.gemspec

@@ -0,0 +1,38 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "hanami/sequel/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "hanami-sequel"
+  spec.version       = Hanami::Sequel::VERSION
+  spec.authors       = ["Malina Sulca"]
+  spec.email         = ["malina.sulca@gmail.com"]
+
+  spec.summary       = %q{Integration of Sequel into Hanami.}
+  spec.description   = %q{Integrates Sequel into Hanami by providing database commands and generating model files.}
+  spec.homepage      = "https://github.com/malin-as/hanami-sequel.git"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "sequel", "~> 5.0"
+  spec.add_dependency "hanami", "~> 1.1.0"
+end

data/lib/hanami/sequel.rb

@@ -0,0 +1,3 @@
+require "hanami/sequel/configuration"
+require "hanami/sequel/cli"
+require "hanami/sequel/version"

data/lib/hanami/sequel/cli.rb

@@ -0,0 +1,62 @@
+require 'fileutils'
+
+module Hanami
+  module Sequel
+    module CLI
+      def self.hanamirc
+        @hanamirc ||= Hanamirc.new(Pathname.new('.'))
+      end
+
+      def self.lib_path
+        @lib_path ||= "lib/#{hanamirc.options[:project]}"
+      end
+
+      def self.models_path
+        @models_path ||= File.join(lib_path, 'models')
+      end
+
+      def self.spec_path
+        @spec_path ||= "spec/#{hanamirc.options[:project]}"
+      end
+
+      def self.config
+        @config ||= Hanami::Sequel::Configuration.new
+      end
+
+      def self.template(name)
+        File.join(File.dirname(__FILE__), 'templates', "#{name}.erb")
+      end
+
+      class ErBinding
+        def initialize(**vars)
+          @vars = vars
+        end
+
+        def bind
+          @vars.each_with_object(binding) do |(k, v), b|
+            b.local_variable_set(k.to_sym, v)
+          end
+        end
+      end
+
+      def self.generate(template, erbinding, destination)
+        raise "File #{destination} already exists" if File.exist?(destination)
+
+        dirname = File.dirname(destination)
+        FileUtils.mkdir_p(dirname) unless Dir.exist?(dirname)
+
+        content = ERB.new(File.read(template))
+                     .result(erbinding&.bind)
+        File.write(destination, content)
+      end
+    end
+  end
+end
+
+require_relative 'commands/create'
+require_relative 'commands/drop'
+require_relative 'commands/install'
+require_relative 'commands/migrate'
+require_relative 'commands/migration'
+require_relative 'commands/model'
+require_relative 'commands/seed'

data/lib/hanami/sequel/commands/create.rb

@@ -0,0 +1,31 @@
+module Hanami
+  module Sequel
+    module CLI
+      class Create < Hanami::CLI::Command
+        def call(**options)
+          Command.create
+        end
+      end
+    end
+
+    module Command
+      def self.create
+        env = Hanami::Environment.new
+        if env.environment == 'production'
+          raise 'Command unavailable in the production environment.'
+        end
+
+        db_url = ENV.fetch('DATABASE_URL')
+        db_conn, _, db_name = db_url.rpartition('/')
+
+        require 'sequel'
+
+        db = ::Sequel.connect("#{db_conn}/postgres",
+                              loggers: Logger.new($stdout))
+        db.run("CREATE DATABASE #{db_name}")
+      end
+    end
+  end
+end
+
+Hanami::CLI.register 'sequel create', Hanami::Sequel::CLI::Create

data/lib/hanami/sequel/commands/drop.rb

@@ -0,0 +1,31 @@
+module Hanami
+  module Sequel
+    module CLI
+      class Drop < Hanami::CLI::Command
+        def call(**options)
+          Command.drop
+        end
+      end
+    end
+
+    module Command
+      def self.drop
+        env = Hanami::Environment.new
+        if env.environment == 'production'
+          raise 'Command unavailable in the production environment.'
+        end
+
+        db_url = ENV.fetch('DATABASE_URL')
+        db_conn, _, db_name = db_url.rpartition('/')
+
+        require 'sequel'
+
+        db = ::Sequel.connect("#{db_conn}/postgres",
+                              loggers: Logger.new($stdout))
+        db.run("DROP DATABASE IF EXISTS #{db_name}")
+      end
+    end
+  end
+end
+
+Hanami::CLI.register 'sequel drop', Hanami::Sequel::CLI::Drop

data/lib/hanami/sequel/commands/install.rb

@@ -0,0 +1,16 @@
+module Hanami
+  module Sequel
+    module CLI
+      class Install < Hanami::CLI::Command
+        def call(**options)
+          Command.drop
+          Command.create
+          Command.migrate
+          Command.seed
+        end
+      end
+    end
+  end
+end
+
+Hanami::CLI.register 'sequel install', Hanami::Sequel::CLI::Install

data/lib/hanami/sequel/commands/migrate.rb

@@ -0,0 +1,42 @@
+module Hanami
+  module Sequel
+    module CLI
+      class Migrate < Hanami::CLI::Command
+        argument :version,
+                 required: false,
+                 default: 'up',
+                 desc: 'Version of the migration (number, offset, timestamp, "up" or "down"). Default: "up"'
+
+        def call(**options)
+          Command.migrate(options)
+        end
+      end
+    end
+
+    module Command
+      def self.migrate(**options)
+        Hanami::Environment.new             # load DATABASE_URL
+
+        args = {}
+
+        if (v = options[:version])
+          case
+          when v == 'up' then;
+          when v == 'down' then args[:target] = 0
+          else args[:target] = Integer(v)
+          end
+        end
+
+        require 'sequel'
+        ::Sequel.extension :migration
+
+        db = ::Sequel.connect(ENV.fetch('DATABASE_URL'),
+                              loggers: Logger.new($stdout))
+
+        ::Sequel::Migrator.run(db, CLI.config.migrations, **args)
+      end
+    end
+  end
+end
+
+Hanami::CLI.register 'sequel migrate', Hanami::Sequel::CLI::Migrate

data/lib/hanami/sequel/commands/migration.rb

@@ -0,0 +1,23 @@
+require 'erb'
+
+module Hanami
+  module Sequel
+    module CLI
+      class Migration < Hanami::CLI::Command
+        argument :name, required: true, desc: 'Name of the migration'
+
+        def call(name:, **options)
+          now = Time.now.strftime('%Y%m%d%H%M%S')
+          name = Utils::String.underscore(name)
+          destination = File.join('./',
+                                  CLI.config.migrations,
+                                  "#{now}_#{name}.rb")
+
+          CLI.generate(CLI.template('migration'), nil, destination)
+        end
+      end
+    end
+  end
+end
+
+Hanami::CLI.register 'sequel migration', Hanami::Sequel::CLI::Migration

data/lib/hanami/sequel/commands/model.rb

@@ -0,0 +1,48 @@
+require 'erb'
+
+module Hanami
+  module Sequel
+    module CLI
+      class Model < Hanami::CLI::Command
+        argument :name, required: true, desc: 'Name of the model'
+
+        def call(name:, **options)
+          under_name = Utils::String.underscore(name)
+          table_name = Utils::String.pluralize(under_name)
+
+          camel_name = Utils::String.classify(name)
+          model_name = "#{camel_name}Model"
+
+          b = ErBinding.new(model_name: model_name,
+                            table_name: table_name)
+
+          # db/migrations/date-create-table_name.rb
+
+          now = Time.now.strftime('%Y%m%d%H%M%S')
+          destination = File.join(CLI.config.migrations,
+                                  "#{now}_create_#{table_name}.rb")
+
+          CLI.generate(CLI.template('model-migration'), b, destination)
+
+          # lib/project_name/models/model_name.rb
+
+          destination = File.join(CLI.lib_path,
+                                  'models',
+                                  "/#{under_name}_model.rb")
+
+          CLI.generate(CLI.template('model-sequel'), b, destination)
+
+          # spec/project_name/models/model_name_spec.rb
+
+          destination = File.join(CLI.spec_path,
+                                  'models',
+                                  "/#{under_name}_model_spec.rb")
+
+          CLI.generate(CLI.template('model-spec'), b, destination)
+        end
+      end
+    end
+  end
+end
+
+Hanami::CLI.register 'sequel model', Hanami::Sequel::CLI::Model