data_migrater 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4edd73a6e979b188bb16be1e3da8459e4bec032c
-  data.tar.gz: ec460ef7043e565a46bf6eefe3c5f4ec8747cda2
+  metadata.gz: a13040b011706340281f05ccfd9bec1d0f1dccbd
+  data.tar.gz: d125de74e4823997d445badbb4b1fc9e35c10265
 SHA512:
-  metadata.gz: e3cd683980e7750d349c2e27a7f76d6d85b665f163e268bcf1fd6133515c7502ef276122a6b882cb268647f08ae3b2da46cfca3c6b1b173cceaf1a989f198602
-  data.tar.gz: 75a673376d5cc02dfd1291eb9d6f05bc3aed4dc5294edb9c086f0d054e580e53fb2081c1130428a51bd3e0574ce783fd9406c295dc8eb4433b7d3bb36dc4defe
+  metadata.gz: 62f37e23c30eacde7c410c3d27f5f82d73a9fadd6ac52d2ea526db44c852b3a8faaf48c99b85ff43c4b81829d6f2c20bc1dcbf0d688716dca4156e6a0a6a49f7
+  data.tar.gz: 429b22415c18dff3dfd8991c2894d662db8a8aae6d1919312e8e7b3db134a090e790201e1f661efac9e8ac9006a7e9904cb1b1d4722b1513683b8b0eb86eb1be

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.2.0
+
+- Added support for custom logger.
+
 # 0.1.1
 
 - Fixed `require` name on `bin` script.

data/README.md

@@ -30,6 +30,38 @@ rails g data_migrater:create name
 Check your `db/data_migrate` folder, the data migration will be there.
 Next time your application run, all pending data migration will be execute.
 
+## Custom Logger
+
+You can send your log to a file including the module `DataMigrater::Logger`.
+
+```
+class MyDataMigration
+  include DataMigrater::Logger
+
+  def execute
+    logger.info "going to log/my_data_migration.log"
+  end
+end
+```
+
+By default, the class name is used and the file goes to `log` folder. You can change it:
+
+```
+class MyDataMigration
+  include DataMigrater::Logger
+
+  data_logger path: "db/data_migrate/log/global.log"
+
+  def execute
+    logger.info "going to db/data_migrate/log/global.log"
+  end
+end
+```
+
+#### Options
+
+`path`: Where the log will be written.
+
 ## Test
 
 Before send pull request, check if specs is passing.

data/lib/data_migrater.rb

@@ -2,7 +2,10 @@ module DataMigrater
 end
 
 require 'data_migration'
+
 require 'data_migrater/collection'
+# require 'data_migrater/csv'
+require 'data_migrater/logger'
 require 'data_migrater/migration'
 require 'data_migrater/migrator'
 require 'data_migrater/version'

data/lib/data_migrater/logger.rb

@@ -0,0 +1,49 @@
+module DataMigrater
+  module Logger
+    extend ActiveSupport::Concern
+
+    included do
+      def logger
+        return @logger if @logger
+
+        @logger = ::Logger.new(path)
+
+        @logger.formatter = formatter
+
+        @logger
+      end
+
+      private
+
+      def default_path
+        "log/#{self.class.name.underscore}.log"
+      end
+
+      def formatter
+        -> (severity, datetime, _progname, message) do
+          "[#{datetime}] #{severity} #{self.class.name}: #{message}\n"
+        end
+      end
+
+      def options
+        self.class.options
+      end
+
+      def path
+        return default_path unless options
+
+        options.fetch :path, default_path
+      end
+    end
+
+    class_methods do
+      def data_logger(options = {})
+        @options = options
+      end
+
+      def options
+        @options
+      end
+    end
+  end
+end

data/lib/data_migrater/version.rb

@@ -1,3 +1,3 @@
 module DataMigrater
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/generators/data_migrater/install_generator.rb

@@ -5,9 +5,7 @@ module DataMigrater
     desc "creates an initializer and copy necessary files."
 
     def create_data_folder
-      folder = 'db/data_migrate'
-
-      FileUtils.mkdir_p folder
+      FileUtils.mkdir_p 'db/data_migrate'
       FileUtils.touch   'db/data_migrate/.keep'
     end
 

data/lib/generators/data_migrater/templates/db/data_migrate/data_migrate.rb.erb

@@ -1,4 +1,11 @@
 class <%= name.camelize %>
+  include DataMigrater::Logger
+
   def execute
+    logger.info "starting..."
+
+    # your data migration here...
+
+    logger.info "done!"
   end
 end

data/spec/csv/data_csv_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+
+class Dummy
+  include DataMigrater::CSV
+
+  data_logger path: "dummy.log"
+
+  def log
+    logger.info "done!"
+  end
+end
+
+RSpec.describe Dummy, "#data_logger" do
+  subject { Dummy.new }
+
+  context "with a given :path" do
+    it "caches the options" do
+      expect(described_class.options).to eq(path: "dummy.log")
+    end
+
+    it "has the right format" do
+      subject.log
+
+      expect(read).to match /\[\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2} -\d{4}\] INFO Dummy: done!\n/
+    end
+  end
+
+  def read
+    File.readlines(described_class.options[:path]).last
+  end
+end

data/spec/logger/data_logger_spec.rb

@@ -0,0 +1,63 @@
+require "spec_helper"
+
+RSpec.describe "#data_logger" do
+  context "with :path" do
+    before do
+      stub_const "Dummy", Class.new
+
+      Dummy.class_eval { include DataMigrater::Logger }
+      Dummy.class_eval { data_logger path: "custom.log" }
+    end
+
+    after :suite do
+      delete :dummy
+    end
+
+    subject { Dummy.new }
+
+    it "logs on the given path file with right content" do
+      subject.logger.info "done!"
+
+      result = /\[\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2} -\d{4}\] INFO Dummy: done!\n/
+
+      expect(File.readlines("custom.log").last).to match result
+    end
+  end
+
+  context "with no :path" do
+    before do
+      stub_const "Dummy", Class.new
+
+      Dummy.class_eval { include DataMigrater::Logger }
+      Dummy.class_eval { data_logger }
+    end
+
+    subject { Dummy.new }
+
+    it "logs on log folder with class name with right content" do
+      subject.logger.info "done!"
+
+      result = /\[\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2} -\d{4}\] INFO Dummy: done!\n/
+
+      expect(File.readlines("log/dummy.log").last).to match result
+    end
+  end
+
+  context "with no :data_logger" do
+    before do
+      stub_const "Dummy", Class.new
+
+      Dummy.class_eval { include DataMigrater::Logger }
+    end
+
+    subject { Dummy.new }
+
+    it "logs on log folder with class name with right content" do
+      subject.logger.info "done!"
+
+      result = /\[\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2} -\d{4}\] INFO Dummy: done!\n/
+
+      expect(File.readlines("log/dummy.log").last).to match result
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,20 +1,9 @@
 ENV['RAILS_ENV'] ||= 'test'
 
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-
 require 'active_record/railtie'
 require 'data_migrater'
+require 'pry-byebug'
 
 ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: ':memory:'
 
-ActiveRecord::Schema.define do
-  create_table :data_migrations do |t|
-    t.string :version, null: false
-  end
-end
-
-RSpec.configure do |config|
-  config.before do
-    DataMigration.destroy_all
-  end
-end
+Dir[File.expand_path('support/**/*.rb', __dir__)].each { |file| require file }

data/spec/support/common.rb

@@ -0,0 +1,7 @@
+require 'rspec/rails'
+
+RSpec.configure do |config|
+  config.filter_run_when_matching :focus
+
+  config.order = :random
+end

data/spec/support/database_cleaner.rb

@@ -0,0 +1,5 @@
+RSpec.configure do |config|
+  config.before do
+    DataMigration.destroy_all
+  end
+end

data/spec/support/methods.rb

@@ -0,0 +1,3 @@
+def delete(file_name)
+  File.delete File.expand_path("../#{file_name}.log", __dir__)
+end

data/spec/support/migrate.rb

@@ -0,0 +1,5 @@
+ActiveRecord::Schema.define do
+  create_table :data_migrations do |t|
+    t.string :version, null: false
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: data_migrater
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - GetNinjas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-05 00:00:00.000000000 Z
+date: 2017-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: pry-byebug
+  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-rails
+  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:
     - - ">="
@@ -94,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -119,6 +161,7 @@ files:
 - README.md
 - lib/data_migrater.rb
 - lib/data_migrater/collection.rb
+- lib/data_migrater/logger.rb
 - lib/data_migrater/migration.rb
 - lib/data_migrater/migrator.rb
 - lib/data_migrater/version.rb
@@ -129,10 +172,16 @@ files:
 - lib/generators/data_migrater/templates/db/data_migrate/data_migrate.rb.erb
 - lib/generators/data_migrater/templates/db/migrate/create_data_migrations.rb
 - spec/collection_spec.rb
+- spec/csv/data_csv_spec.rb
 - spec/data_migration_spec.rb
+- spec/logger/data_logger_spec.rb
 - spec/migrater_spec.rb
 - spec/migration_spec.rb
 - spec/spec_helper.rb
+- spec/support/common.rb
+- spec/support/database_cleaner.rb
+- spec/support/methods.rb
+- spec/support/migrate.rb
 homepage: https://github.com/getninjas/data_migrater
 licenses:
 - MIT
@@ -153,13 +202,19 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: A Data Migrator gem
 test_files:
 - spec/collection_spec.rb
+- spec/csv/data_csv_spec.rb
 - spec/data_migration_spec.rb
+- spec/logger/data_logger_spec.rb
 - spec/migrater_spec.rb
 - spec/migration_spec.rb
 - spec/spec_helper.rb
+- spec/support/common.rb
+- spec/support/database_cleaner.rb
+- spec/support/methods.rb
+- spec/support/migrate.rb