chom 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c1cc091de534a70bdd5eec5eea81e56f7ed37130
+  data.tar.gz: 18eedf9fb794f0e00aa196bfe83936f2d806e55f
+SHA512:
+  metadata.gz: cefec073222ac44f00a0d3cb9266b71cc8927b49f2ecca0b23c97a347e08b5d8a6f928a5cc5d22685a6a2926cc382c2bbcc6fbe1a1ff4f02a1eee93daf23f929
+  data.tar.gz: 414adf10d66c140db8462baf4ce8e909ed5cca3163ac1c9c2204b158a583e19120e3bd7109edacd566d2933f84b3b86fabb8fd3a1497546a0991c04354d5e68c

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,273 @@
+require: rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.3
+  DisplayCopNames: true
+
+Rails:
+  Enabled: false
+
+# Lint/AmbiguousOperator:
+# Lint/AmbiguousRegexpLiteral:
+# Lint/AssignmentInCondition:
+# Lint/BlockAlignment:
+# Lint/CircularArgumentReference:
+# Lint/ConditionPosition:
+# Lint/Debugger:
+# Lint/DefEndAlignment:
+# Lint/DeprecatedClassMethods:
+# Lint/DuplicatedKey:
+# Lint/DuplicateMethods:
+# Lint/EachWithObjectArgument:
+# Lint/ElseLayout:
+# Lint/EmptyEnsure:
+# Lint/EmptyInterpolation:
+# Lint/EndAlignment:
+# Lint/EndInMethod:
+# Lint/EnsureReturn:
+# Lint/Eval:
+# Lint/FloatOutOfRange:
+# Lint/FormatParameterMismatch:
+# Lint/HandleExceptions:
+# Lint/ImplicitStringConcatenation:
+# Lint/IneffectiveAccessModifier:
+# Lint/InvalidCharacterLiteral:
+# Lint/LiteralInCondition:
+# Lint/LiteralInInterpolation:
+# Lint/Loop:
+# Lint/NestedMethodDefinition:
+# Lint/NextWithoutAccumulator:
+# Lint/ParenthesesAsGroupedExpression:
+# Lint/RandOne:
+# Lint/RequireParentheses:
+# Lint/RescueException:
+# Lint/ShadowingOuterLocalVariable:
+# Lint/StringConversionInInterpolation:
+# Lint/UnderscorePrefixedVariableName:
+# Lint/UnneededDisable:
+# Lint/UnreachableCode:
+# Lint/UnusedBlockArgument:
+# Lint/UnusedMethodArgument:
+# Lint/UselessAccessModifier:
+# Lint/UselessAssignment:
+# Lint/UselessComparison:
+# Lint/UselessElseWithoutRescue:
+# Lint/UselessSetterCall:
+# Lint/Void:
+# Metrics/AbcSize:
+# Metrics/BlockNesting:
+# Metrics/ClassLength:
+# Metrics/CyclomaticComplexity:
+Metrics/LineLength:
+  Enabled: true
+  Max: 120
+Metrics/MethodLength:
+  Enabled: true
+  Max: 12
+# Metrics/ModuleLength:
+# Metrics/ParameterLists:
+# Metrics/PerceivedComplexity:
+# Performance/Casecmp:
+# Performance/DoubleStartEndWith:
+# Performance/EndWith:
+# Performance/LstripRstrip:
+# Performance/RangeInclude:
+# Performance/RedundantBlockCall:
+# Performance/RedundantMatch:
+# Performance/RedundantMerge:
+# Performance/RedundantSortBy:
+# Performance/StartWith:
+# Performance/StringReplacement:
+# Performance/TimesMap:
+# Rails/ActionFilter:
+# Rails/Date:
+# Rails/Delegate:
+# Rails/FindBy:
+# Rails/FindEach:
+# Rails/HasAndBelongsToMany:
+# Rails/Output:
+# Rails/PluralizationGrammar:
+# Rails/ReadWriteAttribute:
+# Rails/ScopeArgs:
+# Rails/TimeZone:
+# Rails/UniqBeforePluck:
+# Rails/Validation:
+# RSpec/AnyInstance:
+# RSpec/DescribeClass:
+# RSpec/DescribedClass:
+# RSpec/DescribeMethod:
+# RSpec/ExampleLength:
+# RSpec/ExampleWording:
+# RSpec/FilePath:
+# RSpec/Focus:
+# RSpec/InstanceVariable:
+# RSpec/MultipleDescribes:
+# RSpec/NotToNot:
+# RSpec/VerifiedDoubles:
+# Style/AccessModifierIndentation:
+# Style/AccessorMethodName:
+# Style/Alias:
+# Style/AlignArray:
+# Style/AlignHash:
+# Style/AlignParameters:
+# Style/AndOr:
+# Style/ArrayJoin:
+# Style/AsciiComments:
+# Style/AsciiIdentifiers:
+# Style/Attr:
+# Style/BarePercentLiterals:
+# Style/BeginBlock:
+# Style/BlockComments:
+# Style/BlockDelimiters:
+# Style/BlockEndNewline:
+# Style/BracesAroundHashParameters:
+# Style/CaseEquality:
+# Style/CaseIndentation:
+# Style/CharacterLiteral:
+# Style/ClassAndModuleCamelCase:
+# Style/ClassAndModuleChildren:
+# Style/ClassCheck:
+# Style/ClassMethods:
+# Style/ClassVars:
+# Style/ColonMethodCall:
+# Style/CommentAnnotation:
+# Style/CommentIndentation:
+# Style/ConditionalAssignment:
+# Style/ConstantName:
+# Style/DefWithParentheses:
+# Style/DeprecatedHashMethods:
+Style/Documentation:
+  Enabled: false
+# Style/DotPosition:
+# Style/DoubleNegation:
+# Style/EachWithObject:
+# Style/ElseAlignment:
+# Style/EmptyElse:
+# Style/EmptyLineBetweenDefs:
+# Style/EmptyLines:
+# Style/EmptyLinesAroundAccessModifier:
+# Style/EmptyLinesAroundBlockBody:
+# Style/EmptyLinesAroundClassBody:
+# Style/EmptyLinesAroundMethodBody:
+# Style/EmptyLinesAroundModuleBody:
+# Style/EmptyLiteral:
+# Style/EndBlock:
+# Style/EndOfLine:
+# Style/EvenOdd:
+# Style/ExtraSpacing:
+# Style/FileName:
+# Style/FirstMethodParameterLineBreak:
+# Style/FlipFlop:
+# Style/For:
+# Style/FormatString:
+Style/FrozenStringLiteralComment:
+  Enabled: false
+# Style/GlobalVars:
+# Style/GuardClause:
+# Style/HashSyntax:
+# Style/IdenticalConditionalBranches:
+# Style/IfInsideElse:
+# Style/IfUnlessModifier:
+# Style/IfWithSemicolon:
+# Style/IndentArray:
+# Style/IndentAssignment:
+# Style/IndentationConsistency:
+# Style/IndentationWidth:
+# Style/IndentHash:
+# Style/InfiniteLoop:
+# Style/Lambda:
+# Style/LambdaCall:
+# Style/LeadingCommentSpace:
+# Style/LineEndConcatenation:
+# Style/MethodCallParentheses:
+# Style/MethodDefParentheses:
+# Style/MethodName:
+# Style/ModuleFunction:
+# Style/MultilineArrayBraceLayout:
+# Style/MultilineBlockChain:
+# Style/MultilineBlockLayout:
+# Style/MultilineHashBraceLayout:
+# Style/MultilineIfThen:
+# Style/MultilineMethodCallBraceLayout:
+# Style/MultilineMethodCallIndentation:
+# Style/MultilineMethodDefinitionBraceLayout:
+# Style/MultilineOperationIndentation:
+# Style/MultilineTernaryOperator:
+# Style/MutableConstant:
+# Style/NegatedIf:
+# Style/NegatedWhile:
+# Style/NestedModifier:
+# Style/NestedParenthesizedCalls:
+# Style/NestedTernaryOperator:
+# Style/Next:
+# Style/NilComparison:
+# Style/NonNilCheck:
+# Style/Not:
+# Style/NumericLiterals:
+# Style/OneLineConditional:
+# Style/OpMethod:
+# Style/ParallelAssignment:
+# Style/ParenthesesAroundCondition:
+# Style/PercentLiteralDelimiters:
+# Style/PercentQLiterals:
+# Style/PerlBackrefs:
+# Style/PredicateName:
+# Style/Proc:
+# Style/RaiseArgs:
+# Style/RedundantBegin:
+# Style/RedundantException:
+# Style/RedundantFreeze:
+# Style/RedundantParentheses:
+# Style/RedundantReturn:
+# Style/RedundantSelf:
+# Style/RegexpLiteral:
+# Style/RescueModifier:
+# Style/SelfAssignment:
+# Style/Semicolon:
+# Style/SignalException:
+# Style/SingleLineBlockParams:
+# Style/SingleLineMethods:
+# Style/SpaceAfterColon:
+# Style/SpaceAfterComma:
+# Style/SpaceAfterMethodName:
+# Style/SpaceAfterNot:
+# Style/SpaceAfterSemicolon:
+# Style/SpaceAroundEqualsInParameterDefault:
+# Style/SpaceAroundKeyword:
+# Style/SpaceAroundOperators:
+# Style/SpaceBeforeBlockBraces:
+# Style/SpaceBeforeComma:
+# Style/SpaceBeforeComment:
+# Style/SpaceBeforeFirstArg:
+# Style/SpaceBeforeSemicolon:
+# Style/SpaceInsideBlockBraces:
+# Style/SpaceInsideBrackets:
+# Style/SpaceInsideHashLiteralBraces:
+# Style/SpaceInsideParens:
+# Style/SpaceInsideRangeLiteral:
+# Style/SpaceInsideStringInterpolation:
+# Style/SpecialGlobalVars:
+# Style/StabbyLambdaParentheses:
+# Style/StringLiterals:
+# Style/StringLiteralsInInterpolation:
+# Style/StringMethods:
+# Style/SymbolArray:
+# Style/SymbolProc:
+# Style/Tab:
+# Style/TrailingBlankLines:
+# Style/TrailingCommaInArguments:
+# Style/TrailingCommaInLiteral:
+# Style/TrailingUnderscoreVariable:
+# Style/TrailingWhitespace:
+# Style/TrivialAccessors:
+# Style/UnlessElse:
+# Style/UnneededCapitalW:
+# Style/UnneededInterpolation:
+# Style/UnneededPercentQ:
+# Style/VariableInterpolation:
+# Style/VariableName:
+# Style/WhenThen:
+# Style/WhileUntilDo:
+# Style/WhileUntilModifier:
+# Style/WordArray:
+# Style/ZeroLengthPredicate:

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 sean@smallcity.ca. 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,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Sean Lerner
+
+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,42 @@
+# Chom
+
+Chom is a command line utility that alters the permissions of your current directory and its subdirectories to work properly with your
+web server.
+
+Specificaly, it executes:
+
+    $ chown -R g+w .
+    $ chmod -R <username>:www .
+
+
+## Installation
+
+Install it from the command line:
+
+    $ gem install chom
+
+## Usage
+
+From the command line, go into the directory you'd like to alter the permissions of, and execute:
+
+    $ chom
+
+If permissions weren't able to be altered properly, chom will exit and suggest you attempt with sudo:
+
+    $ sudo chom
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 GitLab at https://gitlab.com/seanlerner/chom. 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).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'chom'
+require 'pry'
+
+Pry.start

data/bin/setup

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+IFS=$'\n\t'
+
+set -vx
+
+bundle install

data/chom.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chom/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'chom'
+  spec.version       = Chom::VERSION
+  spec.authors       = ['Sean Lerner']
+  spec.email         = ['sean@smallcity.ca']
+
+  spec.summary       = 'Utility to chown and chmod a folder recursive so web app has write access to folder.'
+  spec.homepage      = 'https://gitlab.com/seanlerner/chom'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'yard', '~> 0.8'
+end

data/exe/chom

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'chom'
+Chom::App.new.run

data/lib/chom.rb

@@ -0,0 +1,55 @@
+require 'chom/version'
+require 'fileutils'
+
+# Chom is a command line utility that alters the permissions of your current directory and its subdirectories to work
+# properly with your web server.
+#
+# Specificaly, it executes:
+#   $ chown -R g+w .
+#   $ chmod -R <username>:www .
+
+module Chom
+  # The App class stores Chom's functionality. It is executed with Chom::App.new.run.
+  class App
+    attr_reader :user
+
+    # Creates Chom instance and assigns logged in user's username to @user.
+    def initialize
+      @user = Etc.getlogin
+    end
+
+    # Chom command line utility executes run to recursively chown and chmod the current directory.
+    def run
+      chown_dir_and_files_recursively
+      chmod_dir_and_files_recursively
+    end
+
+    private
+
+    # Recursively changes ownership of current directory to the logged in user with the group www.
+    def chown_dir_and_files_recursively
+      print "Attempting 'chown -R g+w .' as '#{@user}'... "
+      FileUtils.chmod_R 'g+w', '.'
+      puts 'Success!'
+    rescue Errno::EPERM
+      puts 'Failed.'
+      suggest_running_as_sudo_and_exit
+    end
+
+    # Recursively changes permissions of current directory to be group writable.
+    def chmod_dir_and_files_recursively
+      print "Attempting 'chmod -R #{@user}:www' as '#{@user}'... "
+      FileUtils.chown_R @user, 'www', '.'
+      puts 'Success!'
+    rescue Errno::EPERM
+      puts 'Failed.'
+      suggest_running_as_sudo_and_exit
+    end
+
+    # Suggests running chom using sudo if regular execution fails due to lack of rights.
+    def suggest_running_as_sudo_and_exit
+      puts "Try running with 'sudo chom'."
+      exit false
+    end
+  end
+end

data/lib/chom/version.rb

@@ -0,0 +1,5 @@
+# This module holds the Chom version information.
+module Chom
+  # This is the Chom version number.
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: chom
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sean Lerner
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: 
+email:
+- sean@smallcity.ca
+executables:
+- chom
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- chom.gemspec
+- exe/chom
+- lib/chom.rb
+- lib/chom/version.rb
+homepage: https://gitlab.com/seanlerner/chom
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Utility to chown and chmod a folder recursive so web app has write access
+  to folder.
+test_files: []
+has_rdoc: