hanami-sequel 1.1.0.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0cbf077a9722ab354ac3278d807fd85f8678202e96e12cad145e7bc711a52b00
-  data.tar.gz: ef3765ac590a0c6425307be2ae8db9af3b9b9346e12e615603b633e19b8b4b78
+  metadata.gz: 95b9e7168e72d4f4ebdc99b780a94c9638b7cc1104d7dcbeb1025134b7ff2541
+  data.tar.gz: ecb1ba24a66d4095fe0719565d12ab2d7820e892c84a1df2ac63f8cb32a749ed
 SHA512:
-  metadata.gz: 60a2077245ac568aee15f8c70a89fb8d88e613f9a0c363ca02ce31bb4aa4085de9af5ca78e8c419f94ab90f1e1ba5761795f3c678e2b8c4435e6cef93afe67d8
-  data.tar.gz: 2c59ce5df2ebd230fd7b8b9e922f75eacb5c04d7325d8a4efcf8d3798cb9db8a7b3e63e561e8d79d372deb487d484635f53964f1815f347a18e0ae6b5893b084
+  metadata.gz: bf4cfa6a759f67ed06bde8bb5db314359e6f472446b041990862c5f55e4e503a21a878f9d1d638dab9b4c0dddd81c544ca4bb8eb84cf4b4a60b7aefa61ca8c61
+  data.tar.gz: 3299160313db47b265a9068fe7a5dff4647e01e5e55c937f0139b4ea4e048fa98da226d2f4131520b4e4d23144bd2cff5ea56c1c7a7cfba86d16b346ea21b880

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.1.1] - 2018-03-19
+### Added
+- The CHANGELOG itself.
+- Provide different templates based on the user’s choice of testing framework,
+currently supporting `minitest` and `RSpec`.
+- Improve the testing framework support by adding default Sequel helpers.
+- Prints on screen the different actions performed on files by each command.
+
+## [1.1.0.1] - 2018-03-06
+### Fixed
+- Push of the correct version to rubygems.org.
+
+## [1.1.0] - 2018-03-06
+### Added
+- Initial release.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hanami-sequel (1.1.0.1)
+    hanami-sequel (1.1.1)
       hanami (~> 1.1.0)
       sequel (~> 5.0)
 

data/README.md

@@ -5,7 +5,7 @@ This gem is designed to replace the `hanami-model` one in your
 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
+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.
 
@@ -20,7 +20,7 @@ Add this line to your `config/environment.rb`:
 require "hamani/sequel/model"
 ```
 
-Add this line to your application's Gemfile (adding the gem to the `plugins`
+Add this line to your application’s Gemfile (adding the gem to the `plugins`
 group ensures that the `hanami` executable is correctly extended):
 
 ```ruby
@@ -35,9 +35,9 @@ And then execute:
 
 ## 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`).
+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
 
@@ -64,7 +64,8 @@ Commands:
     $ hanami sequel model NAME
 
 Where `NAME` is the name of the model. This creates a database migration, a
-Sequel model and a spec file.
+Sequel model and a spec file. Additionally, a Sequel spec helper file will be
+created if none exists.
 
 #### Create a database migration
 
@@ -110,14 +111,20 @@ This command will fail in the `production` environment.
 
     $ hanami sequel install
 
-This command `drop`s, `create`s, `migrate`s, then `seed`s your database. It will fail in
-the `production` environment.
+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.
+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).
+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
 
@@ -126,4 +133,5 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/malin-as/hanami-sequel.
+Bug reports and pull requests are welcome on GitHub at
+[https://github.com/malin-as/hanami-sequel](https://github.com/malin-as/hanami-sequel).

data/lib/hanami/sequel/cli.rb

@@ -7,6 +7,10 @@ module Hanami
         @hanamirc ||= Hanamirc.new(Pathname.new('.'))
       end
 
+      def self.hanamirc_test
+        hanamirc.options[:test] || hanamirc.default_options[:test]
+      end
+
       def self.lib_path
         @lib_path ||= "lib/#{hanamirc.options[:project]}"
       end
@@ -48,6 +52,12 @@ module Hanami
         content = ERB.new(File.read(template))
                      .result(erbinding&.bind)
         File.write(destination, content)
+
+        log_file_handling('create', destination)
+      end
+
+      def self.log_file_handling(verb, file)
+        puts "%12s  %s" % [verb, file]
       end
     end
   end

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

@@ -1,4 +1,5 @@
 require 'erb'
+require 'fileutils'
 
 module Hanami
   module Sequel
@@ -38,7 +39,21 @@ module Hanami
                                   'models',
                                   "/#{under_name}_model_spec.rb")
 
-          CLI.generate(CLI.template('model-spec'), b, destination)
+          model_spec = "model-spec-#{CLI.hanamirc_test}"
+          CLI.generate(CLI.template(model_spec), b, destination)
+
+          # spec/model_helpers.rb
+
+          dest_helper = 'spec/models_helper.rb'
+
+          if File.exist?(dest_helper)
+            CLI.log_file_handling('skip', dest_helper)
+          else
+            model_helper = "models-helper-#{CLI.hanamirc_test}"
+            CLI.generate(CLI.template(model_helper), nil, dest_helper)
+
+            CLI.log_file_handling('create', dest_helper)
+          end
         end
       end
     end

data/lib/hanami/sequel/templates/model-spec-minitest.erb

@@ -0,0 +1,7 @@
+require_relative '../../models_helper.rb'
+
+# This assumes that you are using minitest/test
+
+class Test<%= model_name %> < SequelTestCase
+  # place your tests here
+end

data/lib/hanami/sequel/templates/model-spec-rspec.erb

@@ -0,0 +1,5 @@
+require_relative '../../models_helper.rb'
+
+RSpec.describe <%= model_name %>, type: :model do
+  # place your tests here
+end

data/lib/hanami/sequel/templates/models-helper-minitest.erb

@@ -0,0 +1,13 @@
+# This is for minitest/test
+# cf https://sequel.jeremyevans.net/rdoc/files/doc/testing_rdoc.html
+
+# Use this class as the base class for your tests
+class SequelTestCase < Minitest::Test
+  def run(*args, &block)
+    Sequel::Model.db.transaction(rollback: :always,
+                                 auto_savepoint: true,
+                                 isolation: :serializable) do
+      super
+    end
+  end
+end

data/lib/hanami/sequel/templates/models-helper-rspec.erb

@@ -0,0 +1,19 @@
+RSpec.configure do |config|
+  config.before(:suite) do
+    # you can prepare your database contents here
+  end
+
+  # Each test is ran within a serializable transaction to ensure the maximum
+  # isolation level possible. This allows parallelisation of the tests.
+  config.around(:each, type: :model) do |example|
+    Sequel::Model.db.transaction(rollback: :always,
+                                 auto_savepoint: true,
+                                 isolation: :serializable) do
+      example.run
+    end
+  end
+
+  config.after(:suite) do
+    # you can remove your database contents here
+  end
+end

data/lib/hanami/sequel/version.rb

@@ -1,5 +1,5 @@
 module Hanami
   module Sequel
-    VERSION = "1.1.0.1"
+    VERSION = "1.1.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hanami-sequel
 version: !ruby/object:Gem::Version
-  version: 1.1.0.1
+  version: 1.1.1
 platform: ruby
 authors:
 - Malina Sulca
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-06 00:00:00.000000000 Z
+date: 2018-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -91,6 +91,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -113,7 +114,10 @@ files:
 - lib/hanami/sequel/templates/migration.erb
 - lib/hanami/sequel/templates/model-migration.erb
 - lib/hanami/sequel/templates/model-sequel.erb
-- lib/hanami/sequel/templates/model-spec.erb
+- lib/hanami/sequel/templates/model-spec-minitest.erb
+- lib/hanami/sequel/templates/model-spec-rspec.erb
+- lib/hanami/sequel/templates/models-helper-minitest.erb
+- lib/hanami/sequel/templates/models-helper-rspec.erb
 - lib/hanami/sequel/version.rb
 homepage: https://github.com/malin-as/hanami-sequel.git
 licenses: []

data/lib/hanami/sequel/templates/model-spec.erb

@@ -1,3 +0,0 @@
-RSpec.describe <%= model_name %> do
-  # place your tests here
-end