thunderbird 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 06e03c762e9bef79479708b14604743fe03e509a742ecb60abb5302a2fd16788
+  data.tar.gz: 76d815453006b03948af39ac113ad07db3783d16904a39f71ee00c53fff2d44d
+SHA512:
+  metadata.gz: a61253e0d2559831f38f39d83fe5fa091846930f8b6ca6a6fe5317bb1aeada74e2cb3a480c39a604c85e648801a95904fcb6aeb9c9b896049214c76db5771b74
+  data.tar.gz: 4a5b2825eef339f31e2b9d33ced437e38430711478286d2eb081415648dab451fe547ffa159b97bcdfbe32b16b198b281d9b0e9bff4767bdb32539da9267c566

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,181 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 2.5
+  Exclude:
+    - "bin/stubs/*"
+    - "vendor/**/*"
+
+Gemspec/DateAssignment:
+  Enabled: true
+
+Gemspec/RequireMFA:
+  Enabled: true
+
+Layout/LineEndStringConcatenationIndentation:
+  Enabled: true
+
+Layout/SpaceBeforeBrackets:
+  Enabled: true
+
+Lint/AmbiguousAssignment:
+  Enabled: true
+
+Lint/AmbiguousOperatorPrecedence:
+  Enabled: true
+
+Lint/AmbiguousRange:
+  Enabled: true
+
+Lint/DeprecatedConstants:
+  Enabled: true
+
+Lint/DuplicateBranch:
+  Enabled: true
+
+Lint/DuplicateRegexpCharacterClassElement:
+  Enabled: true
+
+Lint/EmptyBlock:
+  Enabled: true
+
+Lint/EmptyClass:
+  Enabled: true
+
+Lint/EmptyInPattern:
+  Enabled: true
+
+Lint/IncompatibleIoSelectWithFiberScheduler:
+  Enabled: true
+
+Lint/LambdaWithoutLiteralBlock:
+  Enabled: true
+
+Lint/NoReturnInBeginEndBlocks:
+  Enabled: true
+
+Lint/NumberedParameterAssignment:
+  Enabled: true
+
+Lint/OrAssignmentToConstant:
+  Enabled: true
+
+Lint/RedundantDirGlobSort:
+  Enabled: true
+
+Lint/RequireRelativeSelfPath:
+  Enabled: true
+
+Lint/SymbolConversion:
+  Enabled: true
+
+Lint/ToEnumArguments:
+  Enabled: true
+
+Lint/TripleQuotes:
+  Enabled: true
+
+Lint/UnexpectedBlockArity:
+  Enabled: true
+
+Lint/UnmodifiedReduceAccumulator:
+  Enabled: true
+
+Lint/UselessRuby2Keywords:
+  Enabled: true
+
+Naming/BlockForwarding:
+  Enabled: true
+
+Security/IoMethods:
+  Enabled: true
+ 
+Style/AccessorGrouping:
+  Enabled: true
+  EnforcedStyle: separated
+
+Style/ArgumentsForwarding:
+  Enabled: true
+
+Style/CollectionCompact:
+  Enabled: true
+
+Style/DocumentDynamicEvalDefinition:
+  Enabled: true
+
+Style/EmptyCaseCondition:
+  Enabled: false
+
+Style/EndlessMethod:
+  Enabled: true
+
+Style/FileRead:
+  Enabled: true
+
+Style/FileWrite:
+  Enabled: true
+
+Style/HashConversion:
+  Enabled: true
+
+Style/HashExcept:
+  Enabled: true
+
+Style/IfWithBooleanLiteralBranches:
+  Enabled: true
+
+Style/InPatternThen:
+  Enabled: true
+
+Style/MapToHash:
+  Enabled: true
+
+Style/MultilineInPatternThen:
+  Enabled: true
+
+Style/NegatedIf:
+  Enabled: false
+
+Style/NegatedIfElseCondition:
+  Enabled: true
+
+Style/NilLambda:
+  Enabled: true
+
+Style/NumberedParameters:
+  Enabled: true
+
+Style/NumberedParametersLimit:
+  Enabled: true
+
+Style/OpenStructUse:
+  Enabled: true
+
+Style/QuotedSymbols:
+  Enabled: true
+
+Style/RedundantArgument:
+  Enabled: true
+
+Style/RedundantSelfAssignmentBranch:
+  Enabled: true
+
+Style/SelectByRegexp:
+  Enabled: true
+
+Style/StringChars:
+  Enabled: true
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/SwapValues:
+  Enabled: true
+
+Layout/LineLength:
+  Max: 120

data/.rubocop_todo.yml

@@ -0,0 +1,17 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2022-02-06 20:52:48 UTC using RuboCop version 1.25.1.
+# 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: 2
+# Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 25
+
+# Offense count: 2
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
+Metrics/MethodLength:
+  Max: 25

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [0.1.0] - 2022-02-06
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in thunderbird.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Joe Yates
+
+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,23 @@
+# Thunderbird
+
+Interact to the local installation of Mozilla Thunderbird.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'thunderbird'
+```
+
+## Development
+
+Run `rake spec` to run the tests.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/joeyates/thunderbird.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/thunderbird/install.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "thunderbird/profiles"
+
+class Thunderbird
+  # Represents an installation of Thunderbird
+  class Install
+    attr_reader :title
+    attr_reader :entries
+
+    # entries are lines from profile.ini
+    def initialize(title, entries)
+      @title = title
+      @entries = entries
+    end
+
+    def default
+      Thunderbird::Profiles.new.profile_for_path(entries[:Default])
+    end
+  end
+end

data/lib/thunderbird/local_folder.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require "thunderbird/profile"
+require "thunderbird/subdirectory"
+
+class Thunderbird
+  # A local folder is a file containing emails
+  class LocalFolder
+    attr_reader :path
+    attr_reader :profile
+
+    def initialize(profile, path)
+      @profile = profile
+      @path = path
+    end
+
+    def set_up
+      return if path_elements.empty?
+
+      return true if !in_subdirectory?
+
+      subdirectory.set_up
+    end
+
+    def full_path
+      if in_subdirectory?
+        File.join(subdirectory.full_path, folder_name)
+      else
+        folder_name
+      end
+    end
+
+    def exists?
+      File.exist?(full_path)
+    end
+
+    def msf_path
+      "#{path}.msf"
+    end
+
+    def msf_exists?
+      File.exist?(msf_path)
+    end
+
+    private
+
+    def in_subdirectory?
+      path_elements.count > 1
+    end
+
+    def subdirectory
+      return nil if !in_subdirectory?
+
+      Thunderbird::Subdirectory.new(profile, subdirectory_path)
+    end
+
+    def path_elements
+      path.split(File::SEPARATOR)
+    end
+
+    def subdirectory_path
+      File.join(path_elements[0..-2])
+    end
+
+    def folder_name
+      path_elements[-1]
+    end
+  end
+end

data/lib/thunderbird/profile.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "thunderbird"
+
+class Thunderbird
+  # A configured user profile
+  class Profile
+    attr_reader :title
+    attr_reader :entries
+
+    # entries are lines from profile.ini
+    def initialize(title, entries)
+      @title = title
+      @entries = entries
+    end
+
+    def root
+      if relative?
+        File.join(Thunderbird.new.data_path, entries[:Path])
+      else
+        entries[:Path]
+      end
+    end
+
+    def local_folders_path
+      File.join(root, "Mail", "Local Folders")
+    end
+
+    private
+
+    def relative?
+      entries[:IsRelative] == "1"
+    end
+  end
+end

data/lib/thunderbird/profiles.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "thunderbird"
+require "thunderbird/install"
+require "thunderbird/profile"
+
+class Thunderbird
+  # http://kb.mozillazine.org/Profiles.ini_file
+  class Profiles
+    def profile_for_path(path)
+      title, entries = blocks.find { |_name, entries| entries[:Path] == path }
+
+      Thunderbird::Profile.new(title, entries) if title
+    end
+
+    def profile(name)
+      title, entries = blocks.find { |_name, entries| entries[:Name] == name }
+
+      Thunderbird::Profile.new(title, entries) if title
+    end
+
+    def installs
+      @installs ||= begin
+        pairs = blocks.filter { |name, _entries| name.start_with?("Install") }
+        pairs.map { |title, entries| Thunderbird::Install.new(title, entries) }
+      end
+    end
+
+    private
+
+    # Parse profiles.ini.
+    # Blocks start with a title, e.g. '[Abc]'
+    # and are followed by a number of lines
+    def blocks
+      @blocks ||= begin
+        blocks = {}
+        File.open(profiles_ini_path, "rb") do |f|
+          title = nil
+          entries = nil
+
+          loop do
+            line = f.gets
+            if !line
+              blocks[title] = entries if title
+              break
+            end
+
+            line.chomp!
+
+            # Is this line the start of a new block
+            match = line.match(/\A\[([A-Za-z0-9]+)\]\z/)
+            if match
+              # Store what we got before this title as a new block
+              blocks[title] = entries if title
+
+              # Start a new block
+              title = match[1]
+              entries = {}
+            elsif line != ""
+              # Collect entries until we get to the next title
+              key, value = line.split("=")
+              entries[key.to_sym] = value
+            end
+          end
+        end
+
+        blocks
+      end
+    end
+
+    def profiles_ini_path
+      File.join(Thunderbird.new.data_path, "profiles.ini")
+    end
+  end
+end

data/lib/thunderbird/subdirectory.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require "thunderbird/subdirectory_placeholder"
+
+class Thunderbird
+  # Represents a subdirectory containing folders
+  class Subdirectory
+    # `path` is the UI path, it doesn't have the '.sbd' extensions
+    # that are present in the real, file system path
+    attr_reader :path
+    attr_reader :profile
+
+    def initialize(profile, path)
+      @profile = profile
+      @path = path
+    end
+
+    def set_up
+      raise "Cannot create a subdirectory without a path" if !sub_directory?
+
+      if sub_sub_directory?
+        parent_ok = parent.set_up
+        return false if !parent_ok
+      end
+
+      ok = check
+      return false if !ok
+
+      FileUtils.mkdir_p full_path
+      placeholder.touch
+
+      true
+    end
+
+    # subdirectory relative path is 'Foo.sbd/Bar.sbd/Baz.sbd'
+    def full_path
+      relative_path = File.join(subdirectories)
+      File.join(profile.local_folders_path, relative_path)
+    end
+
+    private
+
+    def sub_directory?
+      path_elements.any?
+    end
+
+    def sub_sub_directory?
+      path_elements.count > 1
+    end
+
+    def parent
+      return nil if !sub_sub_directory?
+
+      self.class.new(profile, File.join(path_elements[0..-2]))
+    end
+
+    # placeholder relative path is 'Foo.sbd/Bar.sbd/Baz'
+    def placeholder
+      @placeholder = begin
+        relative_path = File.join(subdirectories[0..-2], path_elements[-1])
+        path = File.join(profile.local_folders_path, relative_path)
+        Thunderbird::SubdirectoryPlaceholder.new(path)
+      end
+    end
+
+    def path_elements
+      path.split(File::SEPARATOR)
+    end
+
+    def exists?
+      File.exist?(full_path)
+    end
+
+    def directory?
+      File.directory?(full_path)
+    end
+
+    def subdirectories
+      path_elements.map { |p| "#{p}.sbd" }
+    end
+
+    def check
+      case
+      when exists? && !placeholder.exists?
+        Kernel.puts "Can't set up folder '#{full_path}': '#{full_path}' exists, but '#{placeholder.path}' is missing"
+        false
+      when placeholder.exists? && !placeholder.regular?
+        Kernel.puts "Can't set up folder '#{full_path}': '#{placeholder.path}' exists, but it is not a regular file"
+        false
+      when exists? && !directory?
+        Kernel.puts "Can't set up folder '#{full_path}': '#{full_path}' exists, but it is not a directory"
+        false
+      else
+        true
+      end
+    end
+  end
+end

data/lib/thunderbird/subdirectory_placeholder.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+class Thunderbird
+  # Each subdirectory is "accompanied" by a blank
+  # file of the same name (without the '.sbd' extension)
+  class SubdirectoryPlaceholder
+    attr_reader :path
+
+    def initialize(path)
+      @path = path
+    end
+
+    def exists?
+      File.exist?(path)
+    end
+
+    def regular?
+      File.file?(path)
+    end
+
+    def touch
+      FileUtils.touch path
+    end
+  end
+end

data/lib/thunderbird/version.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class Thunderbird
+  module Version
+    MAJOR    = 0
+    MINOR    = 1
+    REVISION = 1
+    PRE      = nil
+    VERSION  = [MAJOR, MINOR, REVISION, PRE].compact.map(&:to_s).join(".")
+  end
+end

data/lib/thunderbird.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "os"
+require_relative "thunderbird/version"
+
+# Root information
+class Thunderbird
+  VERSION = Version::VERSION
+
+  def data_path
+    case
+    when OS.linux?
+      File.join(Dir.home, ".thunderbird")
+    when OS.mac?
+      File.join(Dir.home, "Library", "Thunderbird")
+    when OS.windows?
+      File.join(ENV["APPDATA"].gsub("\\", "/"), "Thunderbird")
+    end
+  end
+end

data/thunderbird.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "lib/thunderbird/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "thunderbird"
+  spec.version = Thunderbird::Version::VERSION
+  spec.authors = ["Joe Yates"]
+  spec.email = ["joe.g.yates@gmail.com"]
+
+  spec.summary = "Conveniences for interacting with Mozilla Thunderbird"
+  spec.homepage = "https://github.com/joeyates/thunderbird"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.5"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/joeyates/thunderbird"
+  spec.metadata["changelog_uri"] = "https://github.com/joeyates/thunderbird/blob/main/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = []
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "os"
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: thunderbird
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Joe Yates
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: os
+  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'
+description:
+email:
+- joe.g.yates@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/thunderbird.rb
+- lib/thunderbird/install.rb
+- lib/thunderbird/local_folder.rb
+- lib/thunderbird/profile.rb
+- lib/thunderbird/profiles.rb
+- lib/thunderbird/subdirectory.rb
+- lib/thunderbird/subdirectory_placeholder.rb
+- lib/thunderbird/version.rb
+- thunderbird.gemspec
+homepage: https://github.com/joeyates/thunderbird
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/joeyates/thunderbird
+  source_code_uri: https://github.com/joeyates/thunderbird
+  changelog_uri: https://github.com/joeyates/thunderbird/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Conveniences for interacting with Mozilla Thunderbird
+test_files: []