bigfiles 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f98e9edfdf5e80acdb888bcff5925860185cdb75
-  data.tar.gz: a7ba3c286b3fd6d54027fab10c83098dc63526d7
+SHA256:
+  metadata.gz: c625f268823284a5c9058cd51515ef8127f8ef58c61ad1e4c6c01f79bc89d9a9
+  data.tar.gz: 4938c301bb8d5c9064e797b4a92495a422a90a5c58c32bc2fc03103703e3a694
 SHA512:
-  metadata.gz: 27c3ea11512e8608a75c0ef4dc28f2a936e637131252b8f7e72d188d02f915e6545f859d2dabd41c31dccb4f4ed2a98595dd122e0f63583c1e16983dcc2fe9f9
-  data.tar.gz: c21ba07a949deebe99b71647146ed4bed2faad4f73f041db6538b1d51b58006f91d6ce493bae3c516daa2434f4423b8ada6e65415a48d741af6058419dc15bc6
+  metadata.gz: '08cc96dc7153ffbc18623d2deea513d39ff0df1c67d16fddaa62c81406bafd68c9e05bf9f416a54c87580d865fa3f3214088afb83106edf92e410b7a27ba525d'
+  data.tar.gz: b9415c5f66f9e8120425aea6a730c8e89b529e9bd3eebbc7e6a77ebfaff06f003e867ad9866c4fff5d700595c6dcde51abf2bee63230e977f81baa35e2308bb0

data/.circleci/config.yml

@@ -0,0 +1,134 @@
+---
+version: 2.1
+
+commands:
+  run_with_languages:
+    description: "Run the given command in an environment that includes relevant langauges in the PATH"
+    parameters:
+      command:
+        type: string
+        description: "What command to execute"
+      label:
+        type: string
+        description: "What to label the run"
+        default: <<parameters.command>>
+    steps:
+      - run:
+          name: <<parameters.label>>
+          command: |
+            export PATH="${HOME}/.pyenv/bin:${PATH}"
+            export PATH="${HOME}/.rbenv/bin:${HOME}/.rbenv/shims:${PATH}"
+            export PATH="${HOME}/project/node_modules/.bin:${PATH}"
+            eval "$(pyenv init --path)"
+            eval "$(pyenv virtualenv-init -)"
+            eval "$(rbenv init -)"
+            export BUNDLE_PATH=vendor/bundle
+
+            <<parameters.command>>
+          environment:
+            # https://app.circleci.com/pipelines/github/apiology/cookiecutter-pypackage/4/workflows/29074dc8-944c-4600-8aaa-5116575fed90/jobs/4
+            "LC_ALL": "C.UTF-8"
+            "LANG": "C.UTF-8"
+  set_up_environment:
+    description: "Install source environment"
+    steps:
+      - checkout
+      - run: |
+          sed -E -e 's/bigfiles \([[:digit:]]+.[[:digit:]]+.[[:digit:]]+\)/bigfiles (0.1.0)/g' \
+          Gemfile.lock > Gemfile.lock.deversioned
+      - restore_cache:
+          key: gems-v1-{{ checksum "Gemfile.lock.deversioned" }}
+      - restore_cache:
+          key: wheels-v1-{{ checksum "requirements_dev.txt" }}
+      - run:
+          name: Initialize packages
+          command: |
+            export BUNDLE_PATH=vendor/bundle
+            './fix.sh'
+      - run:
+          name: Verify Gemfile.lock
+          command: |
+            if ! git diff --exit-code Gemfile.lock
+            then
+              >&2 echo "Please resolve changes to Gemfile.lock after bundle install to avoid caching difficulties"
+              exit 1
+            fi
+      - save_cache:
+          key: gems-v1-{{ checksum "Gemfile.lock.deversioned" }}
+          paths:
+            - "vendor/bundle"
+      - save_cache:
+          key: wheels-v1-{{ checksum "requirements_dev.txt" }}
+          paths:
+            - "/home/circleci/.cache/pip/wheels"
+      - run:
+          name: Download new circleci tool
+          command: |
+            curl -fLSs \
+            https://raw.githubusercontent.com/CircleCI-Public/circleci-cli/master/install.sh | sudo bash
+  overcommit:
+    description: "Run overcommit"
+    steps:
+      - set_up_environment
+      - run_with_languages:
+          label: Run overcommit
+          command: |
+            # Coax overcommit into working
+            git config --global user.email "test@test.test"
+            git config --global user.name "Test Test"
+            bundle exec overcommit --sign
+            bundle exec overcommit --sign pre-commit
+
+            bundle exec overcommit --run
+
+jobs:
+  overcommit:
+    docker:
+      - image: apiology/circleci-ruby:latest
+    steps:
+      - when:
+          condition:
+            equal: [<< pipeline.git.branch >>, "main"]
+          steps:
+            - overcommit
+      - unless:
+          condition:
+            equal: [<< pipeline.git.branch >>, "main"]
+          steps:
+            - run: echo "overcommit only runs on main branch"
+  build:
+    working_directory: ~/bigfiles
+    docker:
+      - image: apiology/circleci-ruby:latest
+    steps:
+      - set_up_environment
+      - run_with_languages:
+          label: Test
+          command: |
+            bundle exec rake citest
+            # https://github.com/bluelabsio/records-mover/blob/master/Makefile#L25
+            git status --porcelain coverage/.last_run.json
+            git diff coverage/.last_run.json
+            test -z "$(git status --porcelain coverage/.last_run.json)"
+    # This seemed to shave 5ish% of the build time off when added
+    resource_class: large
+
+workflows:
+  version: 2
+  weekly:
+    triggers:
+      - schedule:
+          cron: "0 0 * * 6"
+          filters:
+            branches:
+              only:
+                - main
+    jobs:
+      - build
+      - overcommit
+  overcommit:
+    jobs:
+      - overcommit
+  build:
+    jobs:
+      - build

data/.envrc

@@ -0,0 +1,2 @@
+# shellcheck shell=bash
+PATH_add bin

data/.git-hooks/pre_commit/circle_ci.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Overcommit
+  module Hook
+    module PreCommit
+      # CircleCI plugin for Overcommit to validate config file (.circleci/config.yml)
+      class CircleCi < Base
+        def run
+          result = execute(command)
+          return :pass if result.success?
+
+          if result.success?
+            :pass
+          else
+            [:fail, result.stderr]
+          end
+        end
+      end
+    end
+  end
+end

data/.gitattributes

@@ -0,0 +1,6 @@
+# there's a lot of .sh in the build machinery; this can overwhelm
+# smaller projects and confuse GitHub's detection of majority project
+# type (GitHub uses the linguist library)
+#
+# https://dev.to/katkelly/changing-your-repo-s-language-in-github-5gjo
+*.sh linguist-detectable=false

data/.gitignore

@@ -0,0 +1,65 @@
+# OSX useful to ignore
+*.DS_Store
+.AppleDouble
+.LSOverride
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+# IntelliJ Idea family of suites
+.idea
+*.iml
+## File-based project format:
+*.ipr
+*.iws
+## mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# IDE settings
+.vscode/
+
+# Editor temp files
+*~
+\#*\#
+
+# Used by Makefile to track what we have and haven't installed
+Gemfile.lock.installed
+requirements_dev.txt.installed
+
+# Used by CircleCI as a place to store installed gems
+/vendor
+
+# Installed by fix.sh based on what latest versions are
+/.python-version
+/.ruby-version
+
+# Ruby-related
+/.bundle/
+/.yardoc
+/_yardoc/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/coverage/.resultset.json
+/coverage/.resultset.json.lock
+/coverage/assets/
+/coverage/index.html
+/coverage/lcov/
+/pkg

data/.markdownlint_style.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+rule 'MD029', style: 'ordered'

data/.mdlrc

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

data/.overcommit.yml

@@ -0,0 +1,55 @@
+---
+# Use this file to configure the Overcommit hooks you wish to use. This will
+# extend the default configuration defined in:
+# https://github.com/sds/overcommit/blob/master/config/default.yml
+#
+# At the topmost level of this YAML file is a key representing type of hook
+# being run (e.g. pre-commit, commit-msg, etc.). Within each type you can
+# customize each hook, such as whether to only run it on certain files (via
+# `include`), whether to only display output if it fails (via `quiet`), etc.
+#
+# For a complete list of hooks, see:
+# https://github.com/sds/overcommit/tree/master/lib/overcommit/hook
+#
+# For a complete list of options that you can use to customize hooks, see:
+# https://github.com/sds/overcommit#configuration
+#
+# Uncomment the following lines to make the configuration take effect.
+
+PreCommit:
+  RuboCop:
+    enabled: true
+    on_warn: fail # Treat all warnings as failures
+    command: ['bundle', 'exec', 'rubocop']
+    include:
+      - '**/*.gemspec'
+      - '**/*.rake'
+      - '**/*.rb'
+      - '**/*.ru'
+      - '**/Gemfile'
+      - '**/Rakefile'
+      - 'bin/*'
+  PythonFlake8:
+    enabled: true
+    on_warn: fail
+  ShellCheck:
+    enabled: true
+    on_warn: fail
+    include:
+      - '.envrc'
+  YamlLint:
+    enabled: true
+    on_warn: fail
+  CircleCi:
+    required_executable: 'circleci'
+    flags: ['config', 'validate']
+    include:
+      - '.circleci/config.yml'
+    enabled: true
+
+#PostCheckout:
+#  ALL: # Special hook name that customizes all hooks of this type
+#    quiet: true # Change all post-checkout hooks to only display output on failure
+#
+#  IndexTags:
+#    enabled: true # Generate a tags file with `ctags` each time HEAD changes

data/.rubocop.yml

@@ -0,0 +1,116 @@
+---
+inherit_from: .rubocop_todo.yml
+
+Layout/LineLength:
+  Max: 120
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Lint/UnusedMethodArgument:
+  AllowUnusedKeywordArguments: true
+
+# https://stackoverflow.com/questions/40934345/rubocop-25-line-block-size-and-rspec-tests
+Metrics/BlockLength:
+  # Exclude DSLs
+  Exclude:
+    - 'Rakefile'
+    - '*.gemspec'
+    - '**/*.rake'
+    - 'spec/**/*.rb'
+    - 'feature/**/*.rb'
+
+# I use keyword arguments for a poor man's dependency injection to cut
+# down on the magic in my tests.
+Metrics/ParameterLists:
+  CountKeywordArgs: false
+
+Naming/HeredocDelimiterNaming:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: true
+  AllowedNames:
+    # I don't think things on this list are a terribly hard convention
+    # for folks to learn.  bbatsov also doesn't care much for this
+    # check:
+    #
+    # https://github.com/rubocop-hq/rubocop/issues/3666
+    - e # exception
+    - x # cartesian coordinates
+    - y # cartesian coordinates
+
+# by default (EnforcedStyle=NormalCase) this rule doesn't like
+# things like check_1, check_2, etc and wants check1, check2, etc. I
+# like the former.
+#
+# https://docs.rubocop.org/rubocop/cops_naming.html#namingvariablenumber
+Naming/VariableNumber:
+  Enabled: true
+  EnforcedStyle: snake_case
+
+# http://www.betterspecs.org/#single
+#
+# > in tests that are not isolated (e.g. ones that integrate with a
+# > DB, an external webservice, or end-to-end-tests), you take a
+# > massive performance hit to do the same setup over and over again,
+# > just to set a different expectation in each test. In these sorts
+# > of slower tests, I think it's fine to specify more than one
+# > isolated behavior.
+RSpec/MultipleExpectations:
+  Exclude:
+    - 'feature/**/*.rb'
+
+#
+# Add 'XX X' to the standard list
+#
+Style/CommentAnnotation:
+  Keywords:
+    - "TOD\
+       O"
+    - "FIXM\
+       E"
+    - "OPTIMIZ\
+       E"
+    - "HAC\
+       K"
+    - "REVIE\
+       W"
+    - "XX\
+       X"
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+  SupportedStyles:
+    - single_quotes
+    - double_quotes
+  ConsistentQuotesInMultiline: true
+
+# I like trailing commas in arrays and hashes.  They let me insert new
+# elements and see them as one line in a diff, not two.
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+# If I'm using one function name and returning the contents of an
+# attribute, that's OK.  The alternative would be this, which I find
+# confusing and often not really what I mean:
+#
+# attr_reader :something_else
+# alias_method :something, :something_else
+Style/TrivialAccessors:
+  ExactNameMatch: true
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.6
+  Exclude:
+    - 'bin/*'
+    - 'feature/samples/**/*'
+    - 'vendor/**/*'
+
+require:
+  - rubocop-rake
+  - rubocop-rspec

data/.rubocop_todo.yml

@@ -0,0 +1,13 @@
+---
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2021-03-31 21:15:30 UTC using RuboCop version 1.12.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 4
+# Configuration parameters: AllowSubject.
+RSpec/MultipleMemoizedHelpers:
+  Max: 10

data/.yamllint.yml

@@ -0,0 +1,8 @@
+---
+# https://yamllint.readthedocs.io/en/stable/configuration.html
+extends: default
+
+rules:
+  comments: disable
+  line-length:
+    max: 120

data/CODE_OF_CONDUCT.md

@@ -1,75 +1,133 @@
+
 # 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.
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
 
 ## Our Standards
 
-Examples of behavior that contributes to creating a positive environment
-include:
+Examples of behavior that contributes to a positive environment for our
+community 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
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
 
-Examples of unacceptable behavior by participants include:
+Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery and unwelcome sexual
-  attention or advances
-* Trolling, insulting/derogatory comments, and personal or political
-  attacks
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or 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
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
 * Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
-## Our Responsibilities
+## Enforcement 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.
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
 
-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.
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
 
 ## 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.
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
 
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at vince.broz@bluelabs.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.
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
 
-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.
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
 
 ## 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]
+version 2.0, available at
+[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
+at [https://www.contributor-covenant.org/translations][translations].
 
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/
+[homepage]: https://www.contributor-covenant.org
+[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations