branch_base 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eac2efb3208cef6e492fac8859c5bf235748568e3e3be1200e7cc617483468c6
+  data.tar.gz: 5fb3a70cab32f0985c776ed703b0b5c099f7ae79402a13359ad284d69362f11d
+SHA512:
+  metadata.gz: 399d80d0011a219e2059df531219e99dfe0625f23db6b17f3a6c8b20e54c44ad6c1bd20cce3911a2113f175295dac46a20cdf0f1023f7197cf71c05237a7a3f2
+  data.tar.gz: 2e28d8259736b9c702c692318cd7b81b8eade7ef3cb800f8397524998d06bc096573efe66a9a9f95426a91f121d5c939cdcb6ca5a52000805b9e38d28e52d650

data/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "bundler" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

data/.github/workflows/ci.yaml

@@ -0,0 +1,76 @@
+name: CI
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - "v**"
+
+  pull_request:
+
+concurrency:
+  group: branch-ci-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  rspec:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    name: Ruby ${{ matrix.ruby }}
+    strategy:
+      matrix:
+        ruby: ["2.7.7", "3.0.5", "3.1.4", "3.2.1"]
+    steps:
+      - uses: actions/checkout@v1
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Configure Git
+        run: |
+          git config --global user.email "shayonj@gmail.com"
+          git config --global user.name "Shayon Mukherjee"
+          git config --global init.defaultBranch main
+
+      - name: Bundle install
+        env:
+          RAILS_ENV: test
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3 --path vendor/bundle
+
+      - name: Run Lint
+        run: bundle exec rubocop
+
+      - name: Run RSpec
+        run: bundle exec rspec
+
+  build-push-image:
+    if: startsWith(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    needs: [rspec]
+    steps:
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+      - name: Login to Docker Hub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      - name: Branch name
+        id: version_name
+        run: |
+          echo ::set-output name=no_v_tag::${GITHUB_REF_NAME:1}
+      - name: Build and push
+        uses: docker/build-push-action@v4
+        with:
+          platforms: linux/amd64,linux/arm64
+          push: true
+          build-args: VERSION=${{ steps.version_name.outputs.no_v_tag }}
+          tags: shayonj/branch_base:latest, shayonj/branch_base:${{ steps.version_name.outputs.no_v_tag }}

data/.gitignore

@@ -0,0 +1,19 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# .gem
+.gem
+
+node_modules
+
+*.db
+.DS_Store

data/.prettierignore

@@ -0,0 +1,4 @@
+/spec/fixtures
+/docs
+/scripts
+*.sql

data/.rspec

@@ -0,0 +1,5 @@
+--format documentation
+--color
+--require spec_helper
+--fail-fast
+--exclude-pattern spec/smoke_spec.rb

data/.rubocop.yml

@@ -0,0 +1,259 @@
+require:
+  - rubocop-rspec
+  - rubocop-rake
+  - rubocop-performance
+
+inherit_mode:
+  merge:
+    - Include
+    - Exclude
+    - AllowedMethods
+
+AllCops:
+  NewCops: enable
+  Exclude:
+    - "**/.git/**/*"
+    - "**/node_modules/**/*"
+    - "**/Brewfile"
+  TargetRubyVersion: 2.7
+
+Bundler/OrderedGems:
+  Include:
+    - "**/Gemfile"
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always
+
+Style/MutableConstant:
+  EnforcedStyle: literals
+
+Style/MethodCallWithArgsParentheses:
+  Enabled: true
+  EnforcedStyle: require_parentheses
+  AllowedMethods:
+    - yield
+    - raise
+    - fail
+    - puts
+    - require
+    - require_relative
+    - render
+    - redirect_to
+    - head
+    - throw
+    # RSpec
+    - to
+    - not_to
+    - to_not
+    - and
+    - or
+  Exclude:
+    - "**/Gemfile"
+    - "**/db/migrate/*"
+    - "**/db/schema.rb"
+
+Style/RedundantInitialize:
+  Enabled: false
+
+Layout:
+  Enabled: false
+
+Metrics:
+  Enabled: false
+
+Naming/AccessorMethodName:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Naming/PredicateName:
+  Enabled: false
+
+Naming/VariableNumber:
+  Enabled: false
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Style/CaseLikeIf:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/CommentAnnotation:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/Lambda:
+  Enabled: false
+
+Style/ModuleFunction:
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false
+
+Style/ParallelAssignment:
+  Enabled: false
+
+Style/PerlBackrefs:
+  Enabled: false
+
+Style/QuotedSymbols:
+  EnforcedStyle: double_quotes
+  Enabled: false
+
+Style/RaiseArgs:
+  Enabled: false
+
+Style/RescueStandardError:
+  Enabled: false
+
+Style/SingleArgumentDig:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  Enabled: false
+
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/TrailingCommaInArguments:
+  Enabled: false
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: false
+
+Style/TrailingUnderscoreVariable:
+  Enabled: false
+
+Style/ZeroLengthPredicate:
+  Enabled: false
+
+Style/DateTime:
+  Enabled: true
+
+RSpec/ExpectChange:
+  EnforcedStyle: block
+
+Gemspec/RequireMFA:
+  Enabled: true
+
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+
+# Temporary Rubocop exclusions
+Style/OpenStructUse:
+  Enabled: false
+
+# Ruby 3 migration exclusions
+Style/HashSyntax:
+  Enabled: false
+
+Naming/BlockForwarding:
+  Enabled: false
+
+Lint/RedundantDirGlobSort:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/VerifiedDoubles:
+  Enabled: false
+
+RSpec/ContextWording:
+  Enabled: false
+
+RSpec/AnyInstance:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/RepeatedDescription:
+  Enabled: false
+
+RSpec/RepeatedExample:
+  Enabled: false
+
+RSpec/HookArgument:
+  Enabled: false
+
+RSpec/DescribeClass:
+  Enabled: false
+
+RSpec/DescribedClass:
+  Enabled: false
+
+RSpec/FilePath:
+  Enabled: false
+
+RSpec/IdenticalEqualityAssertion:
+  Enabled: false
+
+RSpec/InstanceVariable:
+  Enabled: false
+
+RSpec/MissingExampleGroupArgument:
+  Enabled: false
+
+RSpec/MultipleDescribes:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Enabled: false
+
+RSpec/PredicateMatcher:
+  Enabled: false
+
+RSpec/Rails/HttpStatus:
+  Enabled: false
+
+RSpec/RepeatedExampleGroupDescription:
+  Enabled: false
+
+RSpec/StubbedMock:
+  Enabled: false
+
+Lint/UnusedMethodArgument:
+  Enabled: false
+
+Lint/MissingSuper:
+  Enabled: false
+
+RSpec/NoExpectationExample:
+  Enabled: false
+
+Style/AccessorGrouping:
+  Enabled: false
+
+Style/FormatStringToken:
+  Enabled: false

data/Dockerfile

@@ -0,0 +1,5 @@
+FROM ruby:3.1.4
+
+ARG VERSION
+
+RUN gem install branch_bash -v $VERSION

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in pg_easy_replicate.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,124 @@
+PATH
+  remote: .
+  specs:
+    branch_base (0.1.0)
+      rugged
+      sqlite3
+      thor (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.5)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    git (1.18.0)
+      addressable (~> 2.8)
+      rchardet (~> 1.8)
+    haml (6.0.7)
+      temple (>= 0.8.2)
+      thor
+      tilt
+    json (2.7.0)
+    language_server-protocol (3.17.0.3)
+    method_source (1.0.0)
+    parallel (1.23.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    prettier_print (1.2.1)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (5.0.4)
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    rbs (1.0.0)
+    rchardet (1.8.0)
+    regexp_parser (2.8.2)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.58.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.4)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.19.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.24.0)
+      rubocop (~> 1.33)
+    rubocop-packaging (0.5.2)
+      rubocop (>= 1.33, < 2.0)
+    rubocop-performance (1.19.1)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.25.0)
+      rubocop (~> 1.40)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
+    rugged (1.7.1)
+    sqlite3 (1.6.9-arm64-darwin)
+    sqlite3 (1.6.9-x86_64-linux)
+    syntax_tree (6.2.0)
+      prettier_print (>= 1.2.0)
+    syntax_tree-haml (4.0.3)
+      haml (>= 5.2)
+      prettier_print (>= 1.2.1)
+      syntax_tree (>= 6.0.0)
+    syntax_tree-rbs (1.0.0)
+      prettier_print
+      rbs
+      syntax_tree (>= 2.0.1)
+    temple (0.8.2)
+    thor (1.3.0)
+    tilt (2.0.11)
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  arm64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  branch_base!
+  git
+  prettier_print
+  pry
+  rake
+  rspec
+  rubocop
+  rubocop-packaging
+  rubocop-performance
+  rubocop-rake
+  rubocop-rspec
+  syntax_tree
+  syntax_tree-haml
+  syntax_tree-rbs
+
+BUNDLED WITH
+   2.4.13

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Shayon Mukherjee
+
+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,152 @@
+# BranchBase
+
+`branch_base` is a Ruby gem to synchronize data from a Git repository into a SQLite database. It provides a CLI to easily build and store the data, including commits, branches, and file changes, into a SQLite database.
+
+You can now easily run, any kind of analytics on your Git directory using the SQLite database.
+
+![](./internal/screenshot.png)
+
+## Features ✨
+
+- Synchronize Git repository data into a SQLite database.
+- Query commit history, branch details, and file changes using SQL.
+- Easy-to-use CLI for quick setup and execution.
+- 📸 Check out the example below on how you can use `branch_base` to create a Spotify themed Git Wrapped using SQL
+
+## Usage 🛠️
+
+After installation, you can use `branch_base` to generate a SQLite Database of a Git repository:
+
+```bash
+$ branch_base sync ~/src/rails
+```
+
+## Git wrapped 📸
+
+Easily generate a Git wrapped with some built-queries and style using `branch_base`
+
+```bash
+$ branch_base git-wrapped ~/src/rails
+2023-12-03 11:40:50 -0500: INFO - BranchBase: Generating Git wrapped for /Users/shayon/src/rails...
+2023-12-03 11:40:53 -0500: INFO - BranchBase: Git wrapped JSON stored in /Users/shayon/src/rails/git-wrapped.json
+2023-12-03 11:40:53 -0500: INFO - BranchBase: Git wrapped HTML stored in /Users/shayon/src/rails/git-wrapped.html
+```
+
+![](./internal/git-wrapped.png)
+
+## Example SQL Queries 📊
+
+Once your repository data is synchronized into a SQLite database, you can run various SQL queries to analyze the data. Here are some examples:
+
+1. **List all commits**:
+
+   ```sql
+   SELECT * FROM commits;
+   ```
+
+2. **Find commits by a specific author**:
+
+   ```sql
+   SELECT * FROM commits WHERE author = 'John Doe';
+   ```
+
+3. **Get the number of commits in each branch**:
+
+   ```sql
+   SELECT branches.name, COUNT(commits.commit_hash) as commit_count
+   FROM branches
+   JOIN commits ON branches.head_commit = commits.commit_hash
+   GROUP BY branches.name;
+   ```
+
+4. **List files changed in a specific commit**:
+
+   ```sql
+   SELECT files.file_path
+   FROM commit_files
+   JOIN files ON commit_files.file_id = files.file_id
+   WHERE commit_files.commit_hash = 'ABC123';
+   ```
+
+5. **Count of Commits per Author**
+
+   ```sql
+   SELECT author, COUNT(*) as commit_count
+   FROM commits
+   GROUP BY author
+   ORDER BY commit_count DESC;
+   ```
+
+6. **Authors Who Have Worked on a Specific File**
+
+   ```sql
+   SELECT files.file_path, commits.author, COUNT(*) as times_contributed
+   FROM commits
+   JOIN commit_files ON commits.commit_hash = commit_files.commit_hash
+   JOIN files ON commit_files.file_id = files.file_id
+   WHERE files.file_path LIKE '%connection_adapters/sqlite%'
+   GROUP BY files.file_path, commits.author
+   ORDER BY times_contributed DESC;
+   ```
+
+## Installation 📥
+
+### Via RubyGems 💎
+
+You can install `branch_base` directly using RubyGems:
+
+```bash
+$ gem install branch_base
+```
+
+### Via Docker 🐳
+
+`branch_base` is also available as a Docker image, which can be used to run the tool without setting up a Ruby environment:
+
+```bash
+$ docker pull shayonj/branch_base:latest
+```
+
+To use `branch_base` with Docker, you can mount your Git repository as a volume:
+
+```bash
+$ docker run -v /repo/path:/repo shayonj/branch_base sync /repo
+```
+
+This command will create a SQLite database with the repository's data in the path where the command is called from
+
+## Database Schema 🗺️
+
+The SQLite database of the follow tables:
+
+```
+repositories
+  │
+  └─ commits ───── commit_files ── files
+      │                  │              │
+      ├─ branches ───────┘              │
+      │                                 │
+      └─ commit_parents ────────────────┘
+```
+
+**Table Descriptions**:
+
+- `repositories`: Contains details about the repositories.
+- `commits`: Stores individual commits. Each commit is linked to a repository.
+- `branches`: Branch information linked to their latest commits.
+- `files`: Information about files changed in commits. We don't store file contents.
+- `commit_files`: Associates commits with files, including changes.
+- `commit_parents`: Tracks parent-child relationships between commits.
+
+## Contributing 🤝
+
+Contributions to `branch_base` are welcome!
+
+## License 📜
+
+Distributed under the MIT License. See `LICENSE` for more information.
+
+## Development 💻
+
+- Install ruby `3.1.4` using RVM ([instruction](https://rvm.io/rvm/install#any-other-system))
+- `bundle exec rspec` for specs

data/Rakefile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "standalone_migrations"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]