activestorage-audio 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c31019f3eb870d07657ea9829f27c254da8f1f621a35f7be674fecb33f2a29bd
+  data.tar.gz: 8565fc6cd76964fa54e73283bd501da8fa632d719505e290cbe4946c81fab817
+SHA512:
+  metadata.gz: 53982c532789866ed39692ebc8ed6f259c4beca368a3ef0564a6bc448936993f742503627b811e88bac3614708f42710e29fa378eed37f3c388a89488939b386
+  data.tar.gz: 60ecd6e1d46d2887033d1fd3936b1e5ef86b550e0b9a0580f992a2c5200923cf6d32a7cae3c6d15b9e0cee6cc35b4cfd0d2a2ae55fcd0434beded398d496942b

data/.github/workflows/ci.yml

@@ -0,0 +1,23 @@
+name: CI
+on: [push]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby_version: [2.4, 2.5, 2.6, 2.7]
+    steps:
+      - name: Checkout Source Code
+        uses: actions/checkout@v1
+      - name: Install Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby_version: ${{ matrix.ruby_version }}
+      - name: Install FFmpeg
+        use: mstksg/get-package@v1
+        with:
+          apt-get: ffmpeg
+      - name: Bundle Dependencies
+        run: bundle install
+      - name: Run Tests
+        run: bundle exec rake

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,6 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Metrics/BlockLength:
+  Exclude:
+    - lib/tasks/changelog.rake

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# 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.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+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
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/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
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our 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.
+
+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.
+
+## 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.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at tscott@weblinc.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.
+
+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.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in active_storage-audio.gemspec
+gemspec
+
+gem 'minitest', '~> 5.0'
+gem 'mocha', '~> 1.11'
+gem 'rake', '~> 12.0'
+gem 'rubocop', '~> 0.78'
+
+gem 'pry', '~> 0.12.2'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Tom Scott
+
+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,97 @@
+# activestorage-audio
+
+An audio analyzer for [ActiveStorage](https://guides.rubyonrails.org/active_storage_overview.html)
+which will automatically analyze audio files using [FFmpeg](https://www.ffmpeg.org/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_storage-audio'
+```
+
+Then, run:
+
+    $ bundle install
+
+You will also need `ffmpeg` installed. On Debian-based systems, run:
+
+```bash
+$ apt-get install -y ffmpeg
+```
+
+For macOS, run:
+
+```bash
+$ brew install ffmpeg
+```
+
+## Usage
+
+If you're running Rails, `ActiveStorage::Audio::Analyzer` will be
+automatically included in the list of analyzers to run on your uploaded
+files. For a manual setup, add this to your app initialization:
+
+```ruby
+require "activestorage"
+require "activestorage/audio"
+
+ActiveStorage.analyzers << ActiveStorage::Audio::Analyzer
+```
+
+The analyzer will save its data to the `metadata` Hash on an audio file
+`blob`, which can be accessed in the model like so:
+
+```ruby
+class Model < ApplicationRecord
+  has_attached_file :audio
+
+  # Return the duration of this Track
+  #
+  # @return [Float]
+  def duration
+    audio.blob.metadata[:duration] if audio.attached?
+  end
+end
+```
+
+When you `#attach` an audio file to this model, the duration will be
+computed using `ffprobe`, found using the current `$PATH`. If you wish
+to set a custom path to ffprobe, do this in an initializer:
+
+```ruby
+ActiveSupport.paths[:ffprobe] = '/opt/local/bin/ffprobe'
+```
+
+## 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
+
+vBug reports and pull requests are welcome on GitHub at
+https://github.com/tubbo/active_storage-audio. This project is intended
+to be a safe, welcoming space for collaboration, and contributors are
+expected to adhere to the [code of
+conduct](https://github.com/tubbo/active_storage-audio/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ActiveStorage::Audio project's codebases,
+issue trackers, chat rooms and mailing lists is expected to follow the
+[code of
+conduct](https://github.com/tubbo/active_storage-audio/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+load 'lib/tasks/changelog.rake'
+
+RuboCop::RakeTask.new :lint
+
+Rake::TestTask.new :test do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: %i[lint test build]

data/activestorage-audio.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'lib/active_storage/audio/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'activestorage-audio'
+  spec.version       = ActiveStorage::Audio::VERSION
+  spec.authors       = ['Tom Scott']
+  spec.email         = ['tubbo@psychedeli.ca']
+
+  spec.summary       = 'Audio analyzer for uploaded files using ffprobe'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/tubbo/activestorage-audio'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] =
+    'https://tubbo.github.io/activestorage-audio'
+  spec.metadata['changelog_uri'] =
+    'https://tubbo.github.io/activestorage-audio/blob/master/CHANGELOG.md'
+
+  # 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(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |path|
+      path.match(%r{^(test|spec|features)/})
+    end
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activestorage', '>= 5'
+end

data/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+#
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'active_storage/audio'
+require 'pry'
+
+Pry.start

data/bin/rake

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort %(
+      Your `bin/bundle` was not generated by Bundler, so this binstub
+      cannot run.  Replace `bin/bundle` by running
+     `bundle binstubs bundler --force`, then run this command again.
+    )
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/setup

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+# Install FFmpeg
+case "$(uname -s)" in
+  Darwin)
+    brew install ffmpeg
+    ;;
+  Linux)
+    debian="$(grep -qEi 'debian|buntu|mint' /etc/*release)"
+    if [ -n "$debian" ]; then
+      apt-get install -yy ffmpeg
+    fi
+    ;;
+  *)
+    echo "Please install \`ffmpeg\` from source"
+    ;;
+esac
+
+# Install the bundle
+bundle install

data/lib/active_storage/audio.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'active_storage'
+require 'active_storage/audio/version'
+require 'active_storage/audio/analyzer'
+require 'active_storage/audio/railtie' if defined? Rails
+
+module ActiveStorage
+  module Audio
+    class Error < StandardError; end
+
+    # Your code goes here...
+  end
+end

data/lib/active_storage/audio/analyzer.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module ActiveStorage
+  module Audio
+    # Uses `ffprobe` to quickly find information about the track file, such
+    # as duration, bitrate, sample rate, and its codec.
+    class Analyzer < ActiveStorage::Analyzer
+      # Tests whether the given `blob` is an audio file. If so, this
+      # file will be analyzed by the `Audio::Analyzer`.
+      #
+      # @param [ActiveStorage::Blob] blob - Blob to test
+      # @return [Boolean] whether `#audio?` returns true
+      def self.accept?(blob)
+        blob.audio?
+      end
+
+      # Metadata to add to the blob. Any empty values are omitted.
+      #
+      # @return [Hash]
+      def metadata
+        {
+          duration: duration,
+          bit_rate: bit_rate,
+          sample_rate: sample_rate,
+          codec: codec,
+          channels: channels,
+          channel_layout: channel_layout
+        }.compact
+      end
+
+      # Duration of this audio file in seconds.
+      #
+      # @return [Float]
+      def duration
+        stream['duration'].to_f
+      end
+
+      # Bit rate of this audio file, e.g. `16.0`
+      #
+      # @return [Float]
+      def bit_rate
+        stream['bit_rate'].to_f
+      end
+
+      # Sample rate of this audio file, e.g. `44.1`
+      #
+      # @return [Float]
+      def sample_rate
+        stream['sample_rate'].to_i
+      end
+
+      # Codec used to encode this audio file.
+      #
+      # @return [String]
+      def codec
+        stream['codec']
+      end
+
+      # Number of audio channels (1 for mono, 2 for stereo)
+      #
+      # @return [Integer]
+      def channels
+        stream['channels'].to_i
+      end
+
+      # Layout of channels.
+      #
+      # @return [String]
+      def channel_layout
+        stream['channel_layout']
+      end
+
+      private
+
+      # @private
+      # @return [Hash] Raw data from `ffprobe`
+      def probe
+        @probe ||= download_blob_to_tempfile do |file|
+          IO.popen(command(file.path)) do |output|
+            JSON.parse(output.read)
+          end
+        end
+      end
+
+      # @private
+      # @return [Hash] The first stream found in the search.
+      def stream
+        probe['streams'].first
+      end
+
+      # @private
+      # @return [String] Output of the `ffprobe` command execution.
+      def command(path)
+        [
+          ffprobe,
+          '-show_streams',
+          '-v',
+          'error',
+          '-print_format',
+          'json',
+          path
+        ]
+      end
+
+      # @private
+      # @return [String] Path to `ffprobe`.
+      def ffprobe
+        @ffprobe ||= ActiveStorage.paths[:ffprobe] || 'ffprobe'
+      end
+    end
+  end
+end

data/lib/active_storage/audio/railtie.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module ActiveStorage
+  module Audio
+    # Rails hook that automatically appends
+    # `ActiveStorage::Audio::Analyzer` to the collection of analyzers
+    # that `ActiveStorage` will run on uploaded files.
+    class Engine < Rails::Railtie
+      config.active_storage.analyzers.append ActiveStorage::Audio::Analyzer
+    end
+  end
+end

data/lib/active_storage/audio/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveStorage
+  module Audio
+    VERSION = '0.1.0'
+  end
+end

data/lib/activestorage-audio.rb

@@ -0,0 +1 @@
+require 'active_storage/audio'

data/lib/tasks/changelog.rake

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+desc 'Generate CHANGELOG based on Git history'
+task :changelog do
+  # Ensure directory
+  if Dir['.git'].empty?
+    raise "the changelog task must be run from this repo's root directory"
+  end
+
+  # set up & capture git log
+  from =
+    if `git tag`.empty?
+      `git rev-list --max-parents=0 HEAD`.strip
+    else
+      `git describe --tags --abbrev=0`.strip
+    end
+  git_log_format = '%H[/PIECE]%s[/PIECE]%b[/PIECE]%an[/ENTRY]'
+  log = `git log #{from}..HEAD --pretty=format:'#{git_log_format}' --no-merges`
+
+  # assumes only one gemspec in project root
+  gem = Gem::Specification.load(Dir['./*.gemspec'].first)
+  gem_name = gem.name.tr('_', '-').split('-').map(&:capitalize).join(' ')
+  gem_version = gem.version.version
+
+  # Iterate through each commit in the log, cataloging entries and reverts
+  entries = {}
+  reverts = []
+  log.split('[/ENTRY]').each do |commit|
+    pieces = commit.split('[/PIECE]').map(&:strip)
+    sha, subject, body, author = pieces
+
+    next if subject =~ /update changelog/i
+    next if subject =~ /release version/i
+    next if body =~ /no changelog/i
+
+    entries[sha] = {
+      subject: subject,
+      body: body,
+      author: author
+    }
+
+    if subject.start_with?('Revert')
+      reverts << body.match(/[a-f0-9]{40}/)
+      reverts << sha
+    end
+  end
+
+  # Remove revert commits from log entries
+  reverts.each { |key| entries.delete key }
+
+  # guard against empty changelog
+  raise 'the generated changelog must have at least one entry' if entries.empty?
+
+  # set message title
+  message = []
+  message << "#{gem_name} #{gem_version} (#{Date.today})"
+  message << '-' * 80 + "\n"
+
+  # loop through all entries, templetizing their contents
+  entries.each do |_sha, entry|
+    message << "*   #{entry[:subject]}\n"
+    entry[:body].each_line do |line|
+      message << if line.strip.empty?
+                   ''
+                 else
+                   "    #{line.strip}"
+                 end
+    end
+    message << "    #{entry[:author]}\n"
+  end
+
+  # ensure and append to changelog
+  FileUtils.touch('CHANGELOG.md')
+
+  tempfile = Tempfile.new
+  changelog = File.expand_path('./CHANGELOG.md')
+
+  File.open(tempfile, 'a') do |file|
+    file << message.join("\n")
+    file << "\n\n\n"
+    file << File.read(changelog)
+  end
+
+  FileUtils.mv(tempfile, changelog)
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: activestorage-audio
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tom Scott
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activestorage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+description: Audio analyzer for uploaded files using ffprobe
+email:
+- tubbo@psychedeli.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activestorage-audio.gemspec
+- bin/console
+- bin/rake
+- bin/setup
+- lib/active_storage/audio.rb
+- lib/active_storage/audio/analyzer.rb
+- lib/active_storage/audio/railtie.rb
+- lib/active_storage/audio/version.rb
+- lib/activestorage-audio.rb
+- lib/tasks/changelog.rake
+homepage: https://github.com/tubbo/activestorage-audio
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/tubbo/activestorage-audio
+  source_code_uri: https://tubbo.github.io/activestorage-audio
+  changelog_uri: https://tubbo.github.io/activestorage-audio/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Audio analyzer for uploaded files using ffprobe
+test_files: []