same_boat 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9f3a6656115a1292bcf73b4d62595621074e678b
+  data.tar.gz: b891f60415d5f7b21d1bc8695519a9a3c1afe1b1
+SHA512:
+  metadata.gz: c4116a2d67f32b0371ab72c177b73ff8d8e9e19f408939b56b2409173e8238e42158aeb5cfcfdf5c93936297a64080f82efc33431d2e7830a8e714ae22456726
+  data.tar.gz: ca7d194240d5b5b07caa94a4e4641d77490232c60c85888921524fc4b4ccda01129a5c400716f1552cec386a2c1eedbcb3eb95700f9545016cf26fab51463c17

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.same_boat.journal.sample

@@ -0,0 +1,2 @@
+lib/same_boat.rb: 902cf469f88b2bd9915c13a256270ad5f3dc1a8d
+lib/same_boat/version.rb: 221f1f066dcc9547cd561c9b7cc9b0ec7324c31f

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jshitou@aiming-inc.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in same_boat.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jun Sitow
+
+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,80 @@
+# SameBoat
+Sameboat is monitoring forgetting to add something to environment variables (or some files).
+
+For example, add `AWESOME_VALUE=true` to .env.development during development.
+
+It is at deploy time that you notice that you forgot to add it to .env.preview
+
+SameBoat supports to check it in advance.
+
+The procedure is as follows
+1. Create the latest file stamp of the .env group
+2. Update a part of .env group
+3. Check if the file stamp of the .env group is latest
+
+SameBoat hope 3 will be done at your CI.
+
+The command option is somewhat special.
+
+glossary | option name
+--- | ---
+files | `-c --crews`
+file stamp | `-j --journal`
+
+Because they are in the same boat.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'same_boat'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install same_boat
+
+## Usage
+
+```ruby
+# Rakefile
+require 'same_boat/tasks'
+```
+
+### update journal to latest
+`$ rake same_boat:journal` 
+
+### be in the same boat 
+`$ rake same_boat:row`
+
+### specify crews or journal
+```
+$ rake same_boat:journal -c path/to/.env* -j path/to/.some.journal
+$ rake same_boat:row -c path/to/.env* -j path/to/.some.journal
+
+```
+
+
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/same_boat. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SameBoat project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/same_boat/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "same_boat"
+
+# 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/fixtures/.same_boat.journal

@@ -0,0 +1,4 @@
+fixtures/.env.development: 458b76e74087ed76348051fd50708a298ca22581
+fixtures/.env.local: 458b76e74087ed76348051fd50708a298ca22581
+fixtures/.env.sample: 458b76e74087ed76348051fd50708a298ca22581
+fixtures/.env.test: 458b76e74087ed76348051fd50708a298ca22581

data/lib/same_boat/crew.rb

@@ -0,0 +1,35 @@
+module SameBoat
+  class Crew
+    def initialize(file_path)
+      @file_path = file_path
+    end
+
+    def present
+      git? ? git_commit_hash : file_hash
+    end
+
+    def name
+      @file_path
+    end
+
+    private
+
+    def git_commit_hash
+      `git log #{@file_path} | head -n 1 | cut -d ' ' -f2`
+    end
+
+    def file_hash
+      Digest::MD5.hexdigest(File.read(@file_path, 2**7))
+    end
+
+    def git?
+      self.class.git?
+    end
+
+    class << self
+      def git?
+        @_git ||= !!`which git`
+      end
+    end
+  end
+end

data/lib/same_boat/crews.rb

@@ -0,0 +1,23 @@
+module SameBoat
+  class Crews
+    def initialize(crews, journal_path:)
+      @crews, @journal_path = crews, journal_path
+    end
+
+    def row
+      call_over == past_travel
+    end
+
+    def journal
+      File.write(@journal_path, call_over)
+    end
+
+    def call_over
+      @crews.map { |crew| "#{crew.name}: #{crew.present}" }.join
+    end
+
+    def past_travel
+      File.exist?(@journal_path) ? File.read(@journal_path) : ''
+    end
+  end
+end

data/lib/same_boat/tasks.rb

@@ -0,0 +1,41 @@
+require "same_boat"
+
+module SameBoat
+  class Tasks
+    include Rake::DSL if defined? Rake::DSL
+
+    def install_tasks
+      namespace 'same_boat' do
+        desc 'Detect file group diff'
+        task row: :parse_options do
+          same_boat = SameBoat.build(crew_paths: @options[:crews], journal_path: @options[:journal])
+          result = same_boat.row
+          p result
+          exit(result)
+        end
+
+        desc 'Write file groupt stamp'
+        task journal: :parse_options do
+          same_boat = SameBoat.build(crew_paths: @options[:crews], journal_path: @options[:journal])
+          same_boat.journal
+          exit
+        end
+
+        task :parse_options do
+          grouped_argv = ARGV.slice_before(/^-/).map{|a| a.first.start_with?('-') ? [a[0], a[1..-1].join(',')] : a}.flatten
+
+          @options = {}
+          OptionParser.new do |opts|
+            opts.banner = 'Usage: rake same_boat:{row|journal} [options]'
+            opts.on('-c', '--crews FILE_REGEXP', Array) { |v| @options[:crews] = v }
+            opts.on('-j', '--journal JOURNAL_FILE_NAME') { |v| @options[:journal] = v }
+          end.parse!(grouped_argv)
+          @options[:journal] ||= SameBoat::DEFAULT_JOURNAL
+          @options[:crews] ||= Dir[SameBoat::DEFAULT_CREWS]
+        end
+      end
+    end
+  end
+end
+
+SameBoat::Tasks.new.install_tasks

data/lib/same_boat/version.rb

@@ -0,0 +1,3 @@
+module SameBoat
+  VERSION = "0.1.0"
+end

data/lib/same_boat.rb

@@ -0,0 +1,18 @@
+require "same_boat/version"
+
+module SameBoat
+  autoload :Crews, 'same_boat/crews'
+  autoload :Crew, 'same_boat/crew'
+
+  DEFAULT_JOURNAL = '.same_boat.journal'.freeze
+  DEFAULT_CREWS = '.env*'.freeze
+
+  def self.accept(crews, journal_path:)
+    Crews.new(crews, journal_path: journal_path)
+  end
+
+  def self.build(crew_paths:, journal_path:)
+    crews = crew_paths.map { |path| Crew.new(path) }
+    accept(crews, journal_path: journal_path)
+  end
+end

data/same_boat.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "same_boat/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "same_boat"
+  spec.version       = SameBoat::VERSION
+  spec.authors       = ["Jun Sitow"]
+  spec.email         = ["jshitou@aiming-inc.com"]
+
+  spec.summary       = %q{Monitoring files.}
+  spec.description   = %q{Monitoring files. (E.g. .env.development, .env.preview)}
+  spec.homepage      = "https://github.com/shahoxo/same_boat"
+  spec.license       = "MIT"
+
+  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 "fakefs"
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: same_boat
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jun Sitow
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !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'
+description: Monitoring files. (E.g. .env.development, .env.preview)
+email:
+- jshitou@aiming-inc.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".same_boat.journal.sample"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fixtures/.env.development
+- fixtures/.env.local
+- fixtures/.env.sample
+- fixtures/.env.test
+- fixtures/.same_boat.journal
+- lib/same_boat.rb
+- lib/same_boat/crew.rb
+- lib/same_boat/crews.rb
+- lib/same_boat/tasks.rb
+- lib/same_boat/version.rb
+- same_boat.gemspec
+homepage: https://github.com/shahoxo/same_boat
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Monitoring files.
+test_files: []