dump_hook 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7e3ab2dfea012e21d78286bb192ea9991f56f796877d917c9afc5a5720a58c13
+  data.tar.gz: 9088a1c0514ec39ea1c185d5b560b6c309a4840c28481df7a82a553f647d1363
+SHA512:
+  metadata.gz: 1e2fcfa0fbfc91aa1203b918f0b654fa2b071cbb8a747a1a0b765263d8615d56cbf574ef60a7777177c0a262a87c152bcc25ed52ccbd0d45f0e522747160ed25
+  data.tar.gz: 4b9bae4d2badc64e58d94e4aa16f5c0b8b3a1d4d52c2f602f98860006ab3fb70fc7abb3e3addbfd1a3f80633afdf000b9be72d8d2fe0eb00407b9e98e196548f

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at shurik.v.r@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dump-hook.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Alexander Rjazantsev
+
+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,163 @@
+# Dump Hook
+
+A library that helps cache your data received from performing user actions in tests. We use it in our acceptance tests to enhance 
+performance of preparing data for the tests. It contains ways to cache Postgres and MySql DBs and 
+you need to take care about other sources your own.  
+
+## Installation
+
+```ruby
+gem 'dump-hook'
+```
+
+For Rspec/Capybara add to `rails_helper.rb`:
+```ruby
+require "dump_hook"
+
+RSpec.configure do |config|
+  config.include DumpHook
+end
+```
+
+For Cucumber/Capybara add to `env.rb`:
+```ruby
+require "dump_hook"
+
+World(DumpHook)
+```
+
+## Configuration
+
+There are several parameters to run and manage it.
+
+```ruby
+DumpHook.setup do |config|
+  config.database = ActiveRecord::Base.configurations[Rails.env]["database"]
+  config.actual = Date.today.monday.to_s(:number)
+end
+```
+
+### Db settings:
+* `database` - database name
+* `host` - DB server
+* `port` - DB server port
+* `username` - user to connect
+* `password` - password to connect, works just for MySql
+* `database_type` - `postgres`/`mysql`, by default it's `postgres`
+
+It looks like `database` is a single required parameter. Others may be default for you DB connection. In relation to 
+`password` for `postgres` you need to use the url way in `database` parameter in order to set `password`. You may use 
+the gem `database_url` to get this url.
+
+```ruby
+config.database = postgresql://username:password@localhost/database
+```
+### Dump hook settings
+* `actual` - an attribute to manage how long or when you need to create a new dump for your actions. For instance, you 
+may set it to `Date.current` to recreate your dumps every day. By default it's empty and your dumps will not recreate.
+* `remove_old_dumps` - when `actual` is pointed your old dumps will be removed. By default it's `true`.
+* `dumps_location` - by default it's `tmp/dump_hook`. You may pass something more exciting, e.g your current git branch
+or some path to store your dumps in your repo and generate them using CI.
+
+## Usage
+
+*Attention!* It works for clear DB. In case when you have some previous data you may come across with conflicts or 
+incorrect data which may influence your tests.  
+
+There is just single method what wrap your actions and restore dump again
+```ruby
+execute_with_dump(name, opts={}, &block)
+```
+* `name` - identity what explain meaning of this background
+* `opts[:actual]` - the same to the global parameter `actual` what override it
+* `opts[:created_on]` - Date time to use in Time travelling for time dependent tests. In this case `actual` is 
+unnecessary and ignored. If you want to recreate such dumps you need to clean them manually.  
+
+### Capybara example
+```ruby
+execute_with_dump("user_data") do
+  create_superadmin
+  login_as_superadmin
+  go_to_users
+  add_user("John Doe")
+  add_user("Adam Smith")
+  add_user("Robert Martin")
+  add_user("Kent Beck")
+  logout
+end
+
+```
+### Cucumber example
+
+You can use the capybara way or create a wrap step to have all actions in your features
+```ruby
+Given(/^There is "(.*?)" background with:$/) do |name, steps_order|
+  execute_with_dump(name) do
+    steps steps_order.to_s
+  end
+end
+```
+
+and use it in your scenarios
+```cucumber
+Feature: User can modify project
+  Background:
+    Given There is "project_modification" background with:
+    """
+    There is the user data
+    I login as superadmin
+    I create a project "Time tracking"
+    I logout
+    """
+
+  Scenario: I can rename project
+    Given I login as "John Doe"
+      And I go to the projects
+      And I click "Edit" for "Time tracking" project
+     When I fill out "name" with "Time management"
+      And I click "Save"
+     Then I see the notification "Project is updated"  
+```
+
+In this example `There is the user data` is step what wraps the capybara example
+
+## How to add new sources or hooks
+_Disclaimer_: We are working on enhancements
+
+If you need to add yet one source, e.g "we have yet one service and need to dump its data" you may use something similar
+```ruby
+module YourServiceHook
+  def store_dump(filename)
+    super
+    data = YourServiceAPI.import
+    File.open(your_service_filename(filename), "w") do |f| 
+      f.write(data)
+    end
+  end
+
+  def restore_dump(filename)
+    super
+    buffer = File.open(your_service_filename(filename)).read
+    YourServiceAPI.export(buffer)
+  end
+  
+  def your_service_filename
+    filename.gsub(".dump", ".your_service")
+  end
+end
+```
+and add it after `DumpHook` module
+```ruby
+include DumpHook
+include YourServiceHook
+```
+
+## TODO
+
+* Dump other sources like `cookies`, Elastic Search, etc. 
+* Enhance ways of adding hooks to extend current sources without overriding(In progress)
+* Add some sugar to create common dumps for CI or `parallel_tests`
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

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 "dump_hook"
+
+# 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

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/dump_hook.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dump_hook/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dump_hook"
+  spec.version       = DumpHook::VERSION
+  spec.authors       = ["Alexander Ryazantsev"]
+  spec.email         = ["shurik.v.r@gmail.com"]
+
+  spec.summary       = %q{Dumps to cache you backgrounds}
+  spec.description   = %q{We use it for our capybara/Cucumber features.}
+  spec.homepage    = "https://github.com/Anadea/dump_hook"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'timecop'
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "sequel"
+  spec.add_development_dependency "pg"
+  spec.add_development_dependency "mysql2"
+end

data/lib/dump_hook/version.rb

@@ -0,0 +1,3 @@
+module DumpHook
+  VERSION = "0.0.2"
+end

data/lib/dump_hook.rb

@@ -0,0 +1,114 @@
+require "dump_hook/version"
+require "timecop"
+
+module DumpHook
+  class Settings
+    attr_accessor :database,
+                  :dumps_location,
+                  :remove_old_dumps,
+                  :actual,
+                  :database_type,
+                  :username,
+                  :password,
+                  :host,
+                  :port
+
+    def initialize
+      @database = 'please set database'
+      @database_type = 'postgres'
+      @dumps_location = 'tmp/dump_hook'
+      @remove_old_dumps = true
+    end
+  end
+
+  class << self
+    attr_accessor :settings
+  end
+
+  def self.setup
+    self.settings = Settings.new
+    yield(settings)
+  end
+
+  def execute_with_dump(name, opts={}, &block)
+    created_on = opts[:created_on]
+    actual = opts[:actual] || settings.actual
+    create_dirs_if_not_exists
+    filename = full_filename(name, created_on, actual)
+    if File.exists?(filename)
+      restore_dump(filename)
+    else
+      if created_on
+        Timecop.travel(created_on)
+      elsif actual && settings.remove_old_dumps
+        FileUtils.rm(Dir.glob(full_filename(name, nil, "*")))
+      end
+      block.call
+      Timecop.return
+      store_dump(filename)
+    end
+  end
+
+  def settings
+    DumpHook.settings
+  end
+
+  def store_dump(filename)
+    case settings.database_type
+      when 'postgres'
+        args = ['-a', '-x', '-O', '-f', filename, '-Fc', '-T', 'schema_migrations']
+        args.concat(pg_connection_args)
+        Kernel.system("pg_dump", *args)
+      when 'mysql'
+        args = mysql_connection_args
+        args << "--compress"
+        args.concat ["--result-file", filename]
+        args.concat ["--ignore-table", "#{settings.database}.schema_migrations"]
+        Kernel.system("mysqldump", *args)
+    end
+  end
+
+  def restore_dump(filename)
+    case settings.database_type
+      when 'postgres'
+        args = pg_connection_args
+        args << filename
+        Kernel.system("pg_restore", *args)
+      when 'mysql'
+        args = mysql_connection_args
+        args.concat ["-e", "source #{filename}"]
+        Kernel.system("mysql", *args)
+    end
+  end
+
+  def full_filename(name, created_on, actual)
+    name_with_created_on = name
+    if created_on
+      name_with_created_on = "#{name_with_created_on}_#{created_on.to_s(:number)}"
+    elsif actual
+      name_with_created_on = "#{name_with_created_on}_actual#{actual}"
+    end
+    "#{settings.dumps_location}/#{name_with_created_on}.dump"
+  end
+
+  def create_dirs_if_not_exists
+    FileUtils.mkdir_p(settings.dumps_location)
+  end
+
+  def mysql_connection_args
+    args = [settings.database]
+    args.concat ["-u", settings.username] if settings.username
+    args.concat ["-p", settings.password] if settings.password
+    args.concat ["-h", settings.host] if settings.host
+    args.concat ["-P", settings.port] if settings.port
+    args
+  end
+
+  def pg_connection_args
+    args = ['-d', settings.database]
+    args.concat(['-U', settings.username]) if settings.username
+    args.concat(['-h', settings.host]) if settings.host
+    args.concat(['-p', settings.port]) if settings.port
+    args
+  end
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: dump_hook
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Alexander Ryazantsev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-07-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  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: pg
+  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: mysql2
+  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: We use it for our capybara/Cucumber features.
+email:
+- shurik.v.r@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dump_hook.gemspec
+- lib/dump_hook.rb
+- lib/dump_hook/version.rb
+homepage: https://github.com/Anadea/dump_hook
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Dumps to cache you backgrounds
+test_files: []