tty-file 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ad05816965df5179021ae1e70048eac3ae58db78
+  data.tar.gz: 35e7da73870c9bbb6d01a35584bb0537c110903e
+SHA512:
+  metadata.gz: 3dbfc53a540c8f43c130274c02fcf3c2a9cfb0d50cab7b7d0a1e1ba2ab8c92073a61b0c4bf4c0108d005abfc353d65e10190169c689b772c54becfee96bc12e6
+  data.tar.gz: 92a918fd84a1e846d04c374644781f940f28ea0705df7f9ab0da5df7e87f9d0e39c2bd08621b021eed86da4cb7b2e4703ba5430b64860c571c5fe856ba7308cc

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,27 @@
+---
+language: ruby
+sudo: false
+cache: bundler
+script: "bundle exec rake ci"
+rvm:
+  - 2.0.0
+  - 2.1.10
+  - 2.2.5
+  - 2.3.1
+  - ruby-head
+  - rbx
+matrix:
+  include:
+    - rvm: jruby
+      env: JRUBY_OPTS='--server -Xcompile.invokedynamic=false -Xcompat.version=2.0'
+    - rvm: jruby-9.1.2.0
+      env: JRUBY_OPTS='--server -Xcompile.invokedynamic=false'
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby
+    - rvm: rbx
+  fast_finish: true
+branches:
+  only: master
+notifications:
+  email: false

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Change log
+
+## [v0.1.0] - 2016-11-06
+
+* Initial implementation and release
+
+[v0.1.0]: https://github.com/piotrmurach/tty-file/compare/v0.1.0

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 [email]. 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,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'simplecov', '~> 0.10.0'
+  gem 'coveralls', '~> 0.8.2'
+  gem 'webmock',   '~> 2.1.0'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Piotr Murach
+
+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,302 @@
+# TTY::File [![Gitter](https://badges.gitter.im/Join%20Chat.svg)][gitter]
+[![Gem Version](https://badge.fury.io/rb/tty-file.svg)][gem]
+[![Build Status](https://secure.travis-ci.org/piotrmurach/tty-file.svg?branch=master)][travis]
+[![Code Climate](https://codeclimate.com/github/piotrmurach/tty-file/badges/gpa.svg)][codeclimate]
+[![Coverage Status](https://coveralls.io/repos/github/piotrmurach/tty-file/badge.svg)][coverage]
+[![Inline docs](http://inch-ci.org/github/piotrmurach/tty-file.svg?branch=master)][inchpages]
+
+[gitter]: https://gitter.im/piotrmurach/tty
+[gem]: http://badge.fury.io/rb/tty-file
+[travis]: http://travis-ci.org/piotrmurach/tty-file
+[codeclimate]: https://codeclimate.com/github/piotrmurach/tty-file
+[coverage]: https://coveralls.io/github/piotrmurach/tty-file
+[inchpages]: http://inch-ci.org/github/piotrmurach/tty-file
+
+> File manipulation utility methods
+
+## Motivation
+
+Though Ruby's `File` and `FileUtils` provide very robust apis for dealing with files, this library aims to provide level of abstraction that is much convenient with useful logging capabilities.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tty-file'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tty-file
+
+## Contents
+
+* [1. Usage](#1-usage)
+* [2. Interface](#2-interface)
+  * [2.1. binary?](#21-binary)
+  * [2.2. chmod](#22-chmod)
+  * [2.3. copy_file](#23-copy_file)
+  * [2.4. create_file](#24-create_file)
+  * [2.5. diff](#25-diff)
+  * [2.6. download_file](#26-download_file)
+  * [2.7. inject_into_file](#27-inject_into_file)
+  * [2.8. replace_in_file](#28-replace_in_file)
+  * [2.9. append_to_file](#29-apend_to_file)
+  * [2.10. prepend_to_file](#30-prepend_to_file)
+  * [2.11. remove_file](#211-remove_file)
+
+## 1. Usage
+
+```ruby
+TTY::File.replace_in_file('Gemfile', /gem 'rails'/, "gem 'hanami'")
+```
+
+## 2. Interface
+
+The following are methods available for creating and manipulating files.
+
+If you wish to silence verbose output use `verbose: false`. Similarly if you wish to run action without actually triggering any action use `noop: true`.
+
+### 2.1. binary?
+
+To check whether a file is a binary file, i.e. image, executable etc. do:
+
+```ruby
+TTY::File.binary?('image.png') # => true
+```
+
+### 2.2. chmod
+
+To change file modes use `chmod` like so:
+
+```ruby
+TTY::File.chmod('filename.rb', 0777)
+```
+
+There are number of constants available to represent common mode bits such as `TTY::File::U_R`, `TTY::File::O_X` and can be used as follows:
+
+```ruby
+TTY::File.chmod('filename.rb', TTY::File::U_R | TTY::File::O_X)
+```
+
+Apart from traditional octal number definition for file permissions, you can use more convenient permission notation accepted by Unix `chmod` command:
+
+```ruby
+TTY::File.chmod('filename.rb', 'u=wrx,g+x')
+```
+
+The `u`, `g`, and `o` specify the user, group, and other parts of the mode bits. The `a` symbol is equivalent to `ugo`.
+
+### 2.3. copy_file
+
+Copies a file content from relative source to relative destination.
+
+```ruby
+TTY::File.copy_file 'Gemfile', 'Gemfile.bak'
+```
+
+If you provide a block then the file content is yielded:
+
+```ruby
+TTY::File.copy_file('Gemfile', 'app/Gemfile') do |content|
+  "https://rubygems.org\n" + content
+end
+```
+
+If the source file is an `ERB` template then you can provide `:context` in which the file gets evaluted or if `TTY::File` gets included as a module then approprite object context will be used by default. To use `:context` do:
+
+```ruby
+variables = OpenStruct.new
+variables[:foo] = 'bar'
+
+TTY::File.copy_file('templates/application.html.erb', context: variables)
+```
+
+You can also specifie template name surrounding any dynamic variables with `%` to be evaluted:
+
+```ruby
+variables = OpenStruct.new
+variables[:file_name] = 'foo'
+
+TTY::File.copy_file('templates/%file_name%.rb', context: variables)
+# => Creates templates/foo.rb
+```
+
+If the destination is a directory, then copies source inside that directory.
+
+```ruby
+TTY::File.copy_file 'docs/README.md', 'app'
+```
+
+If the destination file already exists, a prompt menu will be displayed to enquire about action:
+
+If you wish to preserve original owner, group, permission and modified time use `:preserve` option:
+
+```ruby
+TTY::File.copy_file 'docs/README.md', 'app', preserve: true
+```
+
+### 2.4. create_file
+
+To create a file at a given destination with the given content use `create_file`:
+
+```ruby
+TTY::File.create_file 'docs/README.md', '## Title header'
+```
+
+On collision with already existing file, a menu is displayed:
+
+You can force to always overwrite file with `:force` option or always skip by providing `:skip`.
+
+### 2.5. diff
+
+To compare files line by line in a system independent way use `diff`:
+
+```ruby
+TTY::File.diff('file_a', 'file_b')
+# =>
+#  @@ -1,4 +1,4 @@
+#   aaa
+#  -bbb
+#  +xxx
+#   ccc
+```
+
+You can also pass additional arguments such as `:format`, `:context_lines` and `:threshold`.
+
+Accepted formats are `:old`, `:unified`, `:context`, `:ed`, `:reverse_ed`, by default the `:unified` format is used.
+
+The `:context_lines` specifies how many extra lines around the differing lines to include in the output. By default its 3 lines.
+
+The `:threshold` sets maximum file size in bytes, by default files larger than `10Mb` are not processed.
+
+```ruby
+TTY::File.diff('file_a', 'file_b', format: :old)
+# =>
+#  1,4c1,4
+#  < aaa
+#  < bbb
+#  < ccc
+#  ---
+#  > aaa
+#  > xxx
+#  > ccc
+```
+
+Equally, you can perform a comparison between a file content and a string content like so:
+
+```ruby
+TTY::File.diff('/path/to/file', 'some long text')
+```
+
+### 2.6. download_file
+
+To download a content from a given address and to save at a given relative location do:
+
+```ruby
+TTY::File.download_file("https://gist.github.com/4701967", "doc/README.md")
+```
+
+If you pass a block then the content will be yielded to allow modification:
+
+```ruby
+TTY::File.download_file("https://gist.github.com/4701967", "doc/README.md") do |content|
+  content.gsub("\n", " ")
+end
+```
+
+By default `download_file` will follow maximum 3 redirects. This can be changed by passing `:limit` option:
+
+```ruby
+TTY::File.download_file("https://gist.github.com/4701967", "doc/README.md", limit: 5)
+# => raises TTY::File::DownloadError
+```
+
+### 2.7. inject_into_file
+
+Inject content into a file at a given location
+
+```ruby
+TTY::File.inject_into_file 'filename.rb', after: "Code below this line\n" do
+  "text to add"
+end
+```
+
+You can also use Regular Expressions in `:after` or `:before` to match file location. The `append_to_file` and `prepend_to_file` allow you to add content at the end and the begging of a file.
+
+### 2.8. replace_in_file
+
+Replace content of a file matching condition.
+
+```ruby
+TTY::File.replace_in_file 'filename.rb', /matching condition/, 'replacement'
+```
+
+### 2.9. append_to_file
+
+Appends text to a file. You can provide the text as a second argument:
+
+```ruby
+TTY::File.append_to_file('Gemfile', "gem 'tty'")
+```
+
+or inside a block:
+
+```ruby
+TTY::File.append_to_file('Gemfile') do
+  "gem 'tty'"
+end
+```
+
+### 2.10. prepend_to_file
+
+Prepends text to a file. You can provide the text as a second argument:
+
+```ruby
+TTY::File.prepend_to_file('Gemfile', "gem 'tty'")
+```
+
+or inside a block:
+
+```ruby
+TTY::File.prepend_to_file('Gemfile') do
+  "gem 'tty'"
+end
+```
+
+### 2.11. remove_file
+
+To remove a file do:
+
+```ruby
+TTY::File.remove_file 'doc/README.md'
+```
+
+You can also pass in `:force` to remove file ignoring any errors:
+
+```ruby
+TTY::File.remove_file 'doc/README.md', force: true
+```
+
+## 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/piotrmurach/tty-file. 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).
+
+## Copyright
+
+Copyright (c) 2016 Piotr Murach. See LICENSE for further details.