finder_tags 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 44ce9becb747591e2f64619d2c40e5d0eb8bd30dea08b27c5d7e606e889b2a3f
+  data.tar.gz: 4883c829448b57244afc7c4581811ea617c16ff53f5c4495af9600c7a5abcf0d
+SHA512:
+  metadata.gz: 2916bc18d40601f8f507945429a78191294bff24f71c7f51f997bd6a7de5d8455de95b90d501c0e8231db20d091171a22087fa8db060beaeaecd5bc38a070ab6
+  data.tar.gz: cd60db529a3a04a6f2be58f4a438ad0cebd002e0fb4fa8ee6d3ceab298e3d848f18428fe7133ed3da0357d99524d67fd25cdd2c59656f515f853acaec95c9f6a

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format Fuubar
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma

data/.travis.yml

@@ -0,0 +1,22 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - "2.6"
+  - "2.7"
+
+before_install: gem install bundler -v 2.0.2
+
+script:
+  - bundle exec rspec
+
+deploy:
+  provider: rubygems
+  api_key:
+    secure: jv8chtPWSI+YvvKR+LWcrIKVbfx3C+Txj5Zx1yO0armgjneAiLZLlwHd6fdRb1s0KVTxqreN1CVYbgTbiKY7DKlEDJNEnFeCv3gbrcDyezuDyhK1Lxdi9OVuU5UUQCEJ8axF7A7tva8QPW1L+4vD6C68rPjSUhR/nycftHOMs/QCGWjBnVI69rmPuLzUIk/acFFodRL8b3TzbpKQZKD6W9tGYEiF4GGgFZHxaBaHx3rDPpe3EBU3qvE3Rz8qVPRxaL6d1RzXCMlqlNMZqscVvRAo/ZWfvuZ6OTiU4NzJ5+7mhLEKcTX1/USNuuC+Xp5IDDFckmGobrFhXNgSqGcg8bTjTOc/ZD1Nce4r+ctPNi7zXEkDehYEKw5b5SaiSzhJcXlzEQt5Y5+ZpKj3SxpihswtRK8IxBReLSUygXrjxzwbW3PQa52xcdoJ9VSIpmcnecdjObhwDMrh7mnAiWUmKUi+j0MbORfRuDfyBlG+y5fh42cocNvF3ylzZaLwkufR/umULsM/qVO8JFCT1kJ68uxXGai1jOM1qLoSFz5nsO5TwHyFEESfEAGDA0BQ71YUU5aywb2Jh0rIONjWtrA9ritFZJoLbifJ6uFfOx5WmOLzMnHKhXta+A8ndJbi3/wWYBNs9degrWF6vNVfygepqD/ycloveEL5yuAjEouSbic=
+  gem: finder_tags
+  on:
+    rvm: "2.7"
+    tags: true
+    repo: telyn/finder_tags
+  skip_cleanup: 'true'

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in finder_tags.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,80 @@
+PATH
+  remote: .
+  specs:
+    finder_tags (0.1.0)
+      binary_plist-parser (~> 0.1.0)
+      ffi-xattr (~> 0.1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    binary_plist-parser (0.1.0)
+    coderay (1.1.3)
+    diff-lcs (1.3)
+    ffi (1.13.1)
+    ffi-xattr (0.1.2)
+      ffi
+    formatador (0.2.5)
+    fuubar (2.5.0)
+      rspec-core (~> 3.0)
+      ruby-progressbar (~> 1.4)
+    guard (2.16.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    listen (3.2.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.5)
+    method_source (1.0.0)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (10.5.0)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    ruby-progressbar (1.10.1)
+    shellany (0.0.1)
+    thor (1.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  finder_tags!
+  fuubar (~> 2.5)
+  guard-rspec (~> 4.7)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.2

data/Guardfile

@@ -0,0 +1,70 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.call("routing/#{m[1]}_routing"),
+      rspec.spec.call("controllers/#{m[1]}_controller"),
+      rspec.spec.call("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Telyn Z.
+
+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,43 @@
+# FinderTags
+
+Library and utilities for dealing with tags from Finder.
+They should run on any OS where
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'finder_tags'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install finder_tags
+
+## Usage
+
+```ruby
+require "finder_tags"
+
+FinderTags.new("path/to/file").tags
+# => [#<struct FinderTags::Tag name="Cool Tag", color=:blue>]
+```
+
+## 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/[USERNAME]/finder_tags.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "finder_tags"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/finder_tags.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "finder_tags/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "finder_tags"
+  spec.version       = FinderTags::VERSION
+  spec.authors       = ["Telyn Z."]
+  spec.email         = ["175827+telyn@users.noreply.github.com"]
+
+  spec.summary       = "Library & utility for reading tags from Finder.app"
+  spec.homepage      = "https://github.com/telyn/finder_tags"
+  spec.license       = "MIT"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/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 { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "binary_plist-parser", "~> 0.1.0"
+  spec.add_dependency "ffi-xattr", "~> 0.1.2"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "fuubar", "~> 2.5"
+  spec.add_development_dependency "guard-rspec", "~> 4.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/finder_tags.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require "ffi-xattr"
+require "binary_plist/parser/bplist00"
+require "finder_tags/titlecase"
+
+using FinderTags::Titlecase
+
+class FinderTags
+  Tag = Struct.new(:name, :color)
+  FINDERINFO_KEY = "com.apple.FinderInfo"
+  USERTAGS_KEY = "com.apple.metadata:_kMDItemUserTags"
+  TAG_BYTE_OFFSET = 9
+
+  # i could do something tricksy (color >> 1), but I don't feel like it
+  # two arrays of colors is fine by me
+  LEGACY_COLORS = %i[
+    none none
+    grey grey
+    green green
+    purple purple
+    blue blue
+    yellow yellow
+    red red
+    orange orange
+  ].freeze
+  MODERN_COLORS = %i[
+    none
+    grey
+    green
+    purple
+    blue
+    yellow
+    red
+    orange
+  ].freeze
+
+  def initialize(file)
+    @file = file
+  end
+
+  def tags
+    tags = extended_tags
+    tags = [legacy_tag] if tags.none? && legacy_tag.color != :none
+    tags
+  end
+
+  def legacy_tag
+    @legacy_tag ||=
+      begin
+        return Tag.new("None", :none) if tag_byte.nil?
+
+        color = LEGACY_COLORS[tag_byte.to_i]
+        Tag.new(color.to_s.titlecase, color)
+      end
+  end
+
+  def extended_tags
+    @extended_tags ||= raw_user_tags.map(&method(:raw_to_tag))
+  end
+
+  private
+
+  attr_reader :file
+
+  def tag_byte
+    finder_info&.unpack("x9C")&.first
+  end
+
+  def finder_info
+    xattr[FINDERINFO_KEY]
+  end
+
+  def raw_user_tags
+    return [] if usertags_xattr.nil?
+
+    BinaryPList::Parser::BPList00
+      .new(StringIO.new(usertags_xattr))
+      .parse
+  end
+
+  def usertags_xattr
+    xattr[USERTAGS_KEY]
+  end
+
+  def raw_to_tag(tag)
+    name, color = tag.split("\n")
+    Tag.new(name, MODERN_COLORS[color.to_i])
+  end
+
+  def xattr
+    @xattr ||= Xattr.new(file)
+  end
+end

data/lib/finder_tags/titlecase.rb

@@ -0,0 +1,9 @@
+class FinderTags
+  module Titlecase
+    refine String do
+      def titlecase
+        self[0].upcase + self[1, length]
+      end
+    end
+  end
+end

data/lib/finder_tags/version.rb

@@ -0,0 +1,3 @@
+class FinderTags
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: finder_tags
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Telyn Z.
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: binary_plist-parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: ffi-xattr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description:
+email:
+- 175827+telyn@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- finder_tags.gemspec
+- lib/finder_tags.rb
+- lib/finder_tags/titlecase.rb
+- lib/finder_tags/version.rb
+homepage: https://github.com/telyn/finder_tags
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/telyn/finder_tags
+  source_code_uri: https://github.com/telyn/finder_tags
+  changelog_uri: https://github.com/telyn/finder_tags/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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.4
+signing_key:
+specification_version: 4
+summary: Library & utility for reading tags from Finder.app
+test_files: []