example_file 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 127253a74db21db286783ea5a8eee2929f7dd85ab11a6d2fe2aadac42aabd56b
+  data.tar.gz: 1bedfb4962cf19fc156d97697a9924980864c56b5556ffff39feb945cc0ffa4e
+SHA512:
+  metadata.gz: e5d2cd033e13c51a2905a7d12f9e530492f081c2edbd674463837965c1c5523751f72c27539797e1b4511762372d07ef959f9f4f2485d7fa923005be791321c1
+  data.tar.gz: 928d302a75284fcc145751762a2f1e56b35f68a992a3ae47a6abfb0955657a4c4133e3a6831f97281fb655e95a825e382b090019ae1336051ac1c1e4e75ef1c8

data/.cirrus.yml

@@ -0,0 +1,35 @@
+bundle_cache: &bundle_cache
+  bundle_cache:
+    folder: /usr/local/bundle
+    fingerprint_script:
+      - echo $CIRRUS_OS
+      - ruby -v
+      - cat Gemfile
+      - cat *.gemspec
+  install_script: bundle update
+
+markdownlint_task:
+  container:
+    image: ruby:latest
+  <<: *bundle_cache
+  rubocop_script: bundle exec mdl .
+
+rubocop_task:
+  container:
+    image: ruby:latest
+  <<: *bundle_cache
+  rubocop_script: bundle exec rubocop
+
+test_task:
+  depends_on:
+    - rubocop
+    - markdownlint
+  container:
+    matrix:
+      image: ruby:2.5
+      image: ruby:2.6
+      image: ruby:2.7
+  <<: *bundle_cache
+  environment:
+    CODECOV_TOKEN: ENCRYPTED[de650f17db291399a09839a898ab3be8d0bb09a14b369f16f31a1831d6db8d826d4601ea7ad87eab99d005ad832846cc]
+  test_script: bundle exec rake

data/.editorconfig

@@ -0,0 +1,18 @@
+root = true
+
+[*]
+indent_style = tab
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+max_line_length = 100
+
+[*.y{a,}ml]
+indent_style = space
+indent_size = 2
+
+[*.md]
+indent_style = space
+indent_size = 4

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+/coverage/

data/.mdl.style.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+all
+
+rule 'MD007', indent: 4
+rule 'MD024', allow_different_nesting: true
+rule 'MD029', style: 'ordered'
+rule 'MD030', ul_single: 3, ul_multi: 3, ol_single: 2, ol_multi: 2

data/.mdlrc

@@ -0,0 +1 @@
+style ".mdl.style.rb"

data/.rspec

@@ -0,0 +1,3 @@
+--warnings
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,58 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+Layout/IndentationStyle:
+  EnforcedStyle: tabs
+  IndentationWidth: 2
+Layout/IndentationWidth:
+  Width: 1
+Layout/LineLength:
+  Max: 100
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Style/ExponentialNotation:
+  Enabled: true
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+Style/RedundantRegexpEscape:
+  Enabled: true
+Style/SlicingWithRange:
+  Enabled: true
+
+Metrics/BlockLength:
+  Exclude:
+    - '*.gemspec'
+    - spec/**/*.rb
+
+AllCops:
+  TargetRubyVersion: 2.5
+
+RSpec/NestedGroups:
+  Max: 6
+RSpec/RepeatedExampleGroupBody:
+  Exclude:
+    ## Variables are generating from context description
+    - spec/example_file_spec.rb

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Alexander Popov
+
+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,96 @@
+# ExampleFile
+
+Class helper for example files. Usualy it's the alternative
+to environment variables (and `.env` files).
+
+You can have git-controlled example files and git-ignored real files.
+For example, configuration, especially with sensitive data.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'example_file'
+```
+
+And then execute:
+
+```shell
+bundle install
+```
+
+Or install it yourself as:
+
+```shell
+gem install example_file
+```
+
+## Usage
+
+```ruby
+require 'example_file'
+
+ExampleFile.new('some_file.example.conf').actualize_regular_file
+```
+
+For `some_file.example.conf` example file there is `some_file.conf`
+regular file.
+
+Editor below is `$EDITOR` environment variable.
+You should set it to your preferred editor, console or GUI
+(console is more comfortable usually for such scenarios).
+
+It'll act in these ways:
+
+*   If there is no regular file:
+    *   create it with content from example and open the editor.
+*   If there is example file with file modified time after regular file:
+    *   If there is no difference between their contents:
+        *   touch regular file for updating its modified time.
+    *   If there is a difference between their contents:
+        *   ask for a further action:
+            *   open the editor;
+            *   just update regular without changes;
+            *   or replace regular file with a content from new example file.
+*   If there is regular file with file modified time after example file:
+    *   do nothing.
+
+You should add example files to git control:
+
+```shell
+git add some_file.example.conf
+```
+
+And ignore regular ones in `.gitignore`:
+
+```gitignore
+some_file.conf
+```
+
+Recursively it'd be like:
+
+```gitignore
+config/**/*
+!config/**/*.example*
+```
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies.
+Then, run `bundle exec rake spec` to run the tests.
+
+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](https://github.com/AlexWayfer/example_file).
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/example_file.gemspec

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative 'lib/example_file/version'
+
+Gem::Specification.new do |spec|
+	spec.name          = 'example_file'
+	spec.version       = ExampleFile::VERSION
+	spec.authors       = ['Alexander Popov']
+	spec.email         = ['alex.wayfer@gmail.com']
+
+	spec.summary       = 'Class helper for example files'
+	spec.description   = <<~DESC
+		Class helper for example files.
+		Usualy it's the alternative to environment variables (and `.env` files).
+		You can have git-controlled example files and git-ignored real files.
+		For example, configuration, especially with sensitive data.
+	DESC
+	spec.license = 'MIT'
+
+	spec.required_ruby_version = '>= 2.5'
+
+	source_code_uri = 'https://github.com/AlexWayfer/example_file'
+
+	spec.homepage = source_code_uri
+
+	spec.metadata['source_code_uri'] = source_code_uri
+
+	spec.metadata['homepage_uri'] = spec.homepage
+
+	# TODO: Put your gem's CHANGELOG.md URL here.
+	# spec.metadata["changelog_uri"] = ""
+
+	# Specify which files should be added to the gem when it is released.
+	# The `git ls-files -z` loads the files in the RubyGem that have been added
+	# into git.
+	spec.files = Dir.chdir(__dir__) do
+		`git ls-files -z`.split("\x0").reject do |file|
+			file.match(%r{^(test|spec|features)/})
+		end
+	end
+	spec.bindir        = 'exe'
+	spec.executables   = spec.files.grep(%r{^exe/}) { |file| File.basename(file) }
+	spec.require_paths = ['lib']
+
+	spec.add_runtime_dependency 'diffy', '~> 3.0'
+	spec.add_runtime_dependency 'highline', '~> 2.0'
+	spec.add_runtime_dependency 'paint', '~> 2.0'
+
+	spec.add_development_dependency 'codecov', '~> 0.1.0'
+	spec.add_development_dependency 'mdl', '~> 0.9.0'
+	spec.add_development_dependency 'pry-byebug', '~> 3.9'
+	spec.add_development_dependency 'rake', '~> 13.0'
+	spec.add_development_dependency 'rspec', '~> 3.9'
+	spec.add_development_dependency 'rubocop', '~> 0.85.0'
+	spec.add_development_dependency 'rubocop-performance', '~> 1.0'
+	spec.add_development_dependency 'rubocop-rspec', '~> 1.0'
+	spec.add_development_dependency 'simplecov', '~> 0.18.0'
+end

data/lib/example_file.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require_relative 'example_file/version'
+
+require 'diffy'
+require 'highline'
+require 'paint'
+
+## Class for example file
+class ExampleFile
+	SUFFIX = '.example'
+	HIGHLINE = HighLine.new
+
+	class << self
+		def all(directory)
+			Dir[File.join(directory, '**', "*#{SUFFIX}*")]
+				.map { |file_name| new file_name }
+		end
+	end
+
+	def initialize(file_name)
+		@file_name = file_name
+		@regular_file_name = @file_name.sub SUFFIX, ''
+
+		@basename =
+			Paint[File.basename(@file_name), :green, :bold]
+		@regular_basename =
+			Paint[File.basename(@regular_file_name), :red, :bold]
+	end
+
+	def actualize_regular_file
+		return create_regular_file unless regular_file_exist?
+
+		return unless new?
+
+		return update_regular_file if diff.chomp.empty?
+
+		ask_question_and_make_actions
+	end
+
+	private
+
+	def new?
+		File.mtime(@file_name) > File.mtime(@regular_file_name)
+	end
+
+	def regular_file_exist?
+		File.exist? @regular_file_name
+	end
+
+	def create_regular_file
+		FileUtils.cp @file_name, @regular_file_name
+		edit_file @regular_file_name
+	end
+
+	def update_regular_file
+		FileUtils.touch @regular_file_name
+	end
+
+	def diff
+		@diff ||= Diffy::Diff
+			.new(@regular_file_name, @file_name, source: 'files', context: 3)
+			.to_s(:color)
+	end
+
+	CHOICES = {
+		yes: proc { edit_file @regular_file_name },
+		replace: proc { rewrite_regular_file },
+		no: proc do
+			update_regular_file
+			puts 'File modified time updated'
+		end
+	}.freeze
+
+	private_constant :CHOICES
+
+	def ask_question_and_make_actions
+		puts warning_with_diff
+
+		HIGHLINE.choose do |menu|
+			menu.layout = :one_line
+
+			menu.prompt = "Do you want to edit #{@regular_basename} ? "
+
+			CHOICES.each do |answer, block|
+				menu.choice(answer) { instance_exec(&block) }
+			end
+		end
+	end
+
+	def warning_with_diff
+		<<~WARN
+			#{@basename} was modified after #{@regular_basename}.
+
+			```diff
+			#{diff}
+			```
+
+		WARN
+	end
+
+	def edit_file(filename)
+		system "eval $EDITOR #{filename}"
+	end
+
+	def rewrite_regular_file
+		File.write @regular_file_name, File.read(@file_name)
+	end
+end

data/lib/example_file/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class ExampleFile
+	VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,231 @@
+--- !ruby/object:Gem::Specification
+name: example_file
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexander Popov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: diffy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: paint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: mdl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.85.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.85.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+description: |
+  Class helper for example files.
+  Usualy it's the alternative to environment variables (and `.env` files).
+  You can have git-controlled example files and git-ignored real files.
+  For example, configuration, especially with sensitive data.
+email:
+- alex.wayfer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".cirrus.yml"
+- ".editorconfig"
+- ".gitignore"
+- ".mdl.style.rb"
+- ".mdlrc"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- example_file.gemspec
+- lib/example_file.rb
+- lib/example_file/version.rb
+homepage: https://github.com/AlexWayfer/example_file
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/AlexWayfer/example_file
+  homepage_uri: https://github.com/AlexWayfer/example_file
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Class helper for example files
+test_files: []