macos-tags 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 82c78fd9522862d6b9cb20ab934d95a3fa360149aa65407cd2cafd6dcd4147ce
+  data.tar.gz: 20ce035ae6cf80790deb97a309374093df9ecc6bf34935a2711e0702daae0d7b
+SHA512:
+  metadata.gz: 3029529f13d354ba29bcc84066200a4674fe9b685e63e9573592e18045866bb3daf45f224fbc6d1985c2985cfdf73f366fc3ead2625edbabb2172d67a12187fe
+  data.tar.gz: 1ef9c59fa9c593325c831e5225e410bd72001525f2c719a8a3648ebc61808cb24e3ecb0f804433b1246ddadbb87b5253c1a6cb023a028e260f87b0915cf3d50d

data/.gitignore

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

data/.ruby-version

@@ -0,0 +1 @@
+3.0

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## [0.1.0] - 2021-05-06
+
+### Added
+- Find all tags in the system
+- Find all tags on a file
+- Find files by tag
+- Release the initial version to rubygems.org

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+gemspec
+

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2021 Nice cabbage LLC
+
+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,82 @@
+# macos-tags
+
+Port of [dmkskn/macos-tags](https://github.com/dmkskn/macos-tags) to Ruby
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'macos-tags'
+```
+
+And then execute:
+
+```shell
+$ bundle install
+```
+
+Or install it yourself as:
+
+```shell
+$ gem install macos-tags
+```
+
+## Usage
+
+```ruby
+require 'macos-tags'
+```
+
+### Get all tags
+
+```ruby
+MacosTags.all_tags
+=> [
+  #<struct MacosTags::Tag label="Urgent", color=#<MacosTags::Color @name="yellow" @value=5>>,
+]
+```
+
+### Find files by tag
+
+```ruby
+> MacosTags.find_files(tag: "Urgent")
+=> [
+  "files"...
+]
+```
+
+### Count files by tag
+
+```ruby
+> MacosTags.count(tag: "Urgent")
+=> 22
+```
+
+### List tags on the file
+
+
+```ruby
+MacosTags.tags(file: "/Users/me/Documents/note.txt")
+=>
+[
+  #<struct MacosTags::Tag label="Urgent", color=#<MacosTags::Color @name="red" @value=6>>,
+  #<struct MacosTags::Tag label="Important", color=#<MacosTags::Color @name="yellow" @value=5>>
+]
+```
+
+## TODOs
+
+- [ ] Enable it to add tags
+- [ ] Enable it to remove tags
+
+## 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/tomoya55/macos-tags.
+

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rake/testtask'
+require 'bundler'
+
+Bundler::GemHelper.install_tasks
+
+task default: [:test]
+
+Rake::TestTask.new do |test|
+  # test.libs << "tests"
+  # test.libs << "lib"
+  test.test_files = Dir['tests/**/test_*.rb']
+  test.verbose = true
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "macos-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/lib/macos-tags.rb

@@ -0,0 +1,135 @@
+require 'ffi-xattr'
+require 'cfpropertylist'
+require 'shellwords'
+
+module MacosTags
+  XATTR_TAGS = "com.apple.metadata:_kMDItemUserTags"
+  XATTR_FINDER_INFO = "com.apple.FinderInfo"
+  ALL_TAGS_PLIST_PATH = "#{Dir.home}/Library/SyncedPreferences/com.apple.finder.plist"
+
+  class Color
+    DEFINITIONS = {
+      none: 0,
+      gray: 1,
+      green: 2,
+      purple: 3,
+      blue: 4,
+      yellow: 5,
+      red: 6,
+      orange: 7,
+    }
+
+    attr_reader :name, :value
+
+    def initialize(_value)
+      @name, @value = DEFINITIONS.find { |k,v| v == _value } || [:none, 0]
+    end
+
+    def inspect
+      "#<MacosTags::Color @name=\"#{name}\" @value=#{value}>"
+    end
+  end
+
+  def all_tags
+    FinderPlist.new.tags
+  end
+  module_function :all_tags
+
+  def find_files(tag:)
+    Mdfinder.find_files(tag_name: tag)
+  end
+  module_function :find_files
+
+  def count(tag:)
+    Mdfinder.count(tag_name: tag)
+  end
+  module_function :count
+
+  def tags(file:)
+    TagParser.new(file).tags
+  end
+  module_function :tags
+
+  class Mdfinder
+    def self.count(tag_name:)
+      new.count(tag_name: tag_name)
+    end
+
+    def self.find_files(tag_name:)
+      new.find_files(tag_name: tag_name)
+    end
+
+    def count(tag_name:)
+      _count(tag_query(tag_name))
+    end
+
+    def find_files(tag_name:)
+      _query(tag_query(tag_name))
+    end
+
+    private
+
+    def _count(query)
+      ret = _query("-count", query)
+      ret[0].to_i
+    end
+
+    def _query(*params)
+      `mdfind #{Shellwords.join(params)}`.split("\n")
+    end
+
+    def tag_query(tag)
+      "kMDItemUserTags == \"#{tag}\""
+    end
+  end
+
+  class Tag < Struct.new(:label, :color, keyword_init: true)
+  end
+
+  class FinderPlist
+    attr_reader :plist
+    def initialize
+      @plist = CFPropertyList::List.new
+      load
+    end
+
+    def tags
+      parse_find_tags.map do |v|
+        Tag.new(label: v.value["n"].value, color: Color.new(v.value["l"].value))
+      end
+    end
+
+    private
+
+    def load
+      plist.load_binary(ALL_TAGS_PLIST_PATH)
+    end
+
+    def parse_find_tags
+      plist.value.value["values"].value["FinderTagDict"].value["value"].value["FinderTags"].value
+    rescue
+      []
+    end
+  end
+
+  class TagParser
+    attr_reader :xattr, :plist
+    def initialize(file)
+      @xattr = Xattr.new(file)
+      @plist = CFPropertyList::List.new
+    end
+
+    def tags
+      parse_raw_tags.value.map do |raw_tag|
+        label, color_val = raw_tag.value.split("\n")
+        Tag.new(label: label, color: Color.new(color_val.to_i))
+      end
+    end
+
+    private
+
+    def parse_raw_tags
+      plist.load_binary_str(xattr[XATTR_TAGS])
+    end
+  end
+end

data/lib/macos-tags/version.rb

@@ -0,0 +1,3 @@
+module MacosTags
+  VERSION = "0.1.0"
+end

data/macos-tags.gemspec

@@ -0,0 +1,34 @@
+require_relative 'lib/macos-tags/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "macos-tags"
+  spec.version       = MacosTags::VERSION
+  spec.authors       = ["Tomoya Hirano"]
+  spec.email         = ["hiranotomoya@gmail.com"]
+
+  spec.summary       = %q{Ruby interface to get macos Finder tags}
+  spec.description   = %q{Ruby interface to get macos Finder tags}
+  spec.homepage      = "https://github.com/tomoya55/macos-tags"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/tomoya55/macos-tags/blob/main/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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_dependency "ffi-xattr"
+  spec.add_dependency "CFPropertyList"
+  spec.add_dependency "rexml"
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+end

data/tests/test_helper.rb

@@ -0,0 +1,5 @@
+require 'minitest/autorun'
+
+Dir.glob(File.join(File.dirname(__FILE__), '..', 'lib', '**', '*.rb')) do |f|
+  require_relative f
+end

data/tests/test_macos_tags.rb

@@ -0,0 +1,9 @@
+require_relative './test_helper'
+
+describe MacosTags do
+  describe ".all_tags" do
+    it "must returns tags list" do
+      _(MacosTags.all_tags).must_be_kind_of(Array)
+    end
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: macos-tags
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tomoya Hirano
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi-xattr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: CFPropertyList
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby interface to get macos Finder tags
+email:
+- hiranotomoya@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/macos-tags.rb
+- lib/macos-tags/version.rb
+- macos-tags.gemspec
+- tests/test_helper.rb
+- tests/test_macos_tags.rb
+homepage: https://github.com/tomoya55/macos-tags
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/tomoya55/macos-tags
+  source_code_uri: https://github.com/tomoya55/macos-tags
+  changelog_uri: https://github.com/tomoya55/macos-tags/blob/main/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.2.15
+signing_key:
+specification_version: 4
+summary: Ruby interface to get macos Finder tags
+test_files: []