mayaml 4.0.4 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5bb3b0bd0bbb2df9518ac61c424b637c5cf5ae7bbfc233344f06b7c152114c0
-  data.tar.gz: 13e83b858121e3097e22f88253c3395a311c4d1fcbeb4f6632c49a39999dd97a
+  metadata.gz: b1a2cc0729f9e6289cf3f91e4ecbfb67471cae58ac168eff55711079bc90fd9a
+  data.tar.gz: f3910c55a87c3522ba5efebd8c497a24971c69e3f31a2b30b400f10eea7d1e0d
 SHA512:
-  metadata.gz: d5c2b018469af9536a0d1d0cf3fbc0f44f20b1212c7a28888ef8125a8f59ca0cd86c7e6df7149cc382d721f313c418b09d2c3adf4c70cd6b15bf54b3117126dd
-  data.tar.gz: 732303822e54253dafef109280587428222621d84bbb51ce56c7bdd1b8a1e916602114587f931c5749601338f6f9cd2358928b8e03c1492e6d16245d48dfce98
+  metadata.gz: 58488c42247204a511581bfc7a1a80f5f6bd4bca563cbfff41ec05700f1f3b9eea79fb514a923439e43217b7336dcef3f15d83a29c6e4557907e67d24b567a2a
+  data.tar.gz: 8c11e026f550e33d70bbb8e8455dbe896724a4ced341111af49eeb4c81e2ae614766d2022f090a3545765f4785a08e31e5aa0bdd5a0e8c5f4cbab244e21d7386

data/CHANGELOG.md

@@ -1,60 +1,66 @@
-### 4.0.4 (2018.07.07)
+# develop
+
+# 5.0.0 (2024.02.22)
+
+* refactoring
+
+# 4.0.4 (2018.07.07)
 
 * update travis
 
-### 4.0.3 (2018.07.07)
+# 4.0.3 (2018.07.07)
 
 * update docs
 
-### 4.0.2 (2018.07.07)
+# 4.0.2 (2018.07.07)
 
 * update license
 * update to ruby 2.5
 
-### 4.0.1 (2017.04.06)
+# 4.0.1 (2017.04.06)
 
 * update license
 * fix makefile
 * cleanup
 
-### 4.0.0 (2017.04.06)
+# 4.0.0 (2017.04.06)
 
 * add smpt_server attribute
 * some refactoring
 * update license and cleanup
 
-### 3.0.1 (2017.04.06)
+# 3.0.1 (2017.04.06)
 
 * fix travis integration
 * cleanup
 
-### 3.0.0 (2016.09.07)
+# 3.0.0 (2016.09.07)
 
 * add new required arrtibutes: `smtp_protocol`, `smtp_port` and `smtp_authenticator`
 * 4 valid account types: `imap`, `pop3`, `imapssl`, `pop3ssl`
 
-### 2.0.1 (2016.08.31)
+# 2.0.1 (2016.08.31)
 
 * update tests
 
-### 2.0.0 (2016.08.31)
+# 2.0.0 (2016.08.31)
 
 * add new attributes to the mail_account format: `default` and `realname`
 * now only `mailboxes` and `default` attributes are optional
 * add travis integration
 
-### 1.0.3 (2016.06.24)
+# 1.0.3 (2016.06.24)
 
 * fix bin script
 
-### 1.0.2 (2016.06.24)
+# 1.0.2 (2016.06.24)
 
 * fix bin path in gemspec
 
-### 1.0.1 (2016.06.24)
+# 1.0.1 (2016.06.24)
 
 * fix typos in docs
 
-### 1.0.0 (2016.06.24)
+# 1.0.0 (2016.06.24)
 
 * publication of the code

data/README.md

@@ -1,9 +1,8 @@
 # MAYaml
 
 [![Gem Version](https://badge.fury.io/rb/mayaml.svg)](http://badge.fury.io/rb/mayaml)
-[![Code Climate](https://codeclimate.com/github/skopciewski/mayaml/badges/gpa.svg)](https://codeclimate.com/github/skopciewski/mayaml)
 
-This is a base package for mail accounts configuration generators. The idea is to store mail accounts configuration in one Yaml file and then generates dedicated configs for specific programs (like getmail, mutt, etc...).
+This is a package for generating mutt configuration based on the yaml config. The idea is to store mail accounts configuration in one Yaml file and then generates dedicated mutt environment to handle them.
 
 ## Installation
 
@@ -21,8 +20,9 @@ Or install it yourself as:
 
 ## Usage
 
-If ruby bin dir is in your PATH, just call `mayaml-check <path_to_the_yaml_file>` to list recognized accounts.
-On the other hand, In plugins:
+If ruby bin dir is in your PATH, just call `mayaml-mutt-init <path_to_the_yaml_file> <mutt_config_dir>`.
+
+Or
 
 ```ruby
 require "mayaml"

data/bin/mayaml-mutt-init

@@ -0,0 +1,75 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "mayaml"
+require "fileutils"
+require "yaml"
+
+def check_yaml_path(yaml_path)
+  if yaml_path.nil?
+    puts_ussage_message
+    exit 1
+  end
+  return if File.exist? yaml_path
+  puts "Could not find file: #{yaml_path}"
+  exit 1
+end
+
+def check_destintaion_dir(dir)
+  if dir.nil?
+    puts_ussage_message
+    exit 1
+  end
+  return if Dir.exist? dir
+  puts "Unknown destination dir: #{dir}"
+  exit 1
+end
+
+def puts_ussage_message
+  puts <<-END_HELP
+    Ussage: mayaml-mutt-init <path_to_yaml_file> <destination_dir>
+  END_HELP
+end
+
+def get_accounts(yaml_path)
+  Psych.safe_load_file yaml_path, symbolize_names: true
+rescue
+  puts "Could not parse file: #{yaml_path}"
+  exit 1
+end
+
+def create_files(data)
+  data.each do |hsh|
+    path = hsh.keys.first
+    content = hsh.values.first
+    FileUtils.mkdir_p File.dirname(path)
+    File.open(path, "w") do |f|
+      f.write(content)
+    end
+    pp "* File created: #{path}"
+  end
+end
+
+def create_aliases(data)
+  data.each do |hsh|
+    path = hsh.keys.first
+    dest = hsh.values.first
+    FileUtils.ln_s(dest, path, force: true)
+    pp "* Symlink created: #{dest} -> #{path}"
+  end
+end
+
+def main(args)
+  yaml_path = args.shift
+  destination_dir = args.shift
+  check_yaml_path yaml_path
+  check_destintaion_dir destination_dir
+  accounts = get_accounts yaml_path
+  create_files Mayaml::Base.mutt_configs_accounts_handler.execute accounts, destination_dir
+  create_files Mayaml::Base.mutt_configs_init_handler.execute accounts, destination_dir
+  create_files Mayaml::Base.mutt_configs_static_handler.execute destination_dir
+  create_aliases Mayaml::Base.mutt_configs_default_account_handler.execute accounts, destination_dir
+  # destination_file.nil? ? present_configs(configs) : store_configs(configs, destination_file)
+end
+
+main ARGV

data/lib/mayaml/base.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "mainapp/base"
+require "ougai"
+
+module Mayaml
+  class Base
+    extend ::Mainapp::Base
+  end
+
+  STRUCTURE = {
+    logger: Ougai::Logger.new($stdout).tap do |logger|
+      logger.level = Kernel.const_get(ENV["LOG_LEVEL"] || "Logger::INFO")
+      logger.with_fields = {name: "mayaml"}
+    end
+  }.freeze
+
+  ::Mayaml::Base.set Mayaml::STRUCTURE
+end

data/lib/mayaml/mutt_account_alternates/generator.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "mainapp/component"
+require "mustache"
+
+module Mayaml
+  module MuttAccountAlternates
+    class Generator
+      include ::Mainapp::Component
+      attr_struct :logger, :presenter, :validator
+
+      def render(data)
+        validate_data(data)
+        render_view(data)
+      end
+
+      private
+
+      def validate_data(data)
+        validator.validate data
+      end
+
+      def render_view(data)
+        ::Mustache.template_path = __dir__
+        ::Mustache.render :template, presenter.for_render(data)
+      end
+    end
+  end
+end

data/lib/mayaml/mutt_account_alternates/presenter.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "mainapp/component"
+
+module Mayaml
+  module MuttAccountAlternates
+    class Presenter
+      include ::Mainapp::Component
+      attr_struct :logger
+
+      def for_render(data)
+        {
+          accounts: data.map { _1[:name] }.join(" ")
+        }
+      end
+    end
+  end
+end

data/lib/mayaml/mutt_account_alternates/template.mustache

@@ -0,0 +1 @@
+alternates {{ accounts }}

data/lib/mayaml/mutt_account_alternates/validator.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "mainapp/component"
+
+module Mayaml
+  module MuttAccountAlternates
+    class Validator
+      include ::Mainapp::Component
+      attr_struct :logger
+
+      def validate(data)
+        raise ArgumentError.new "Missing accounts value" if data.nil?
+        raise ArgumentError.new "Invalid accounts value" unless data.is_a? Array
+        raise ArgumentError.new "Empty accounts value" if data.empty?
+      end
+    end
+  end
+end

data/lib/mayaml/mutt_account_alternates.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "mayaml/base"
+require "mayaml/mutt_account_alternates/generator"
+require "mayaml/mutt_account_alternates/presenter"
+require "mayaml/mutt_account_alternates/validator"
+
+module Mayaml
+  module MuttAccountAlternates
+    STRUCTURE = {
+      mutt_account_alternates_generator: proc do
+        Generator.new(
+          logger: logger.child(component: "mutt_account_alternates_generator"),
+          presenter: mutt_account_alternates_presenter,
+          validator: mutt_account_alternates_validator
+        )
+      end,
+      mutt_account_alternates_validator: proc do
+        Validator.new(
+          logger: logger.child(component: "mutt_account_alternates_validator")
+        )
+      end,
+      mutt_account_alternates_presenter: proc do
+        Presenter.new(
+          logger: logger.child(component: "mutt_account_alternates_presenter")
+        )
+      end
+    }.freeze
+
+    ::Mayaml::Base.set STRUCTURE
+  end
+end

data/lib/mayaml/mutt_account_creds/generator.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "mainapp/component"
+require "mustache"
+
+module Mayaml
+  module MuttAccountCreds
+    class Generator
+      include ::Mainapp::Component
+      attr_struct :logger, :presenter, :validator
+
+      def render(data)
+        validate_data(data)
+        render_view(data)
+      end
+
+      private
+
+      def validate_data(data)
+        validator.validate data
+      end
+
+      def render_view(data)
+        ::Mustache.template_path = __dir__
+        ::Mustache.render :template, presenter.for_render(data)
+      end
+    end
+  end
+end

data/lib/mayaml/mutt_account_creds/presenter.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "mainapp/component"
+
+module Mayaml
+  module MuttAccountCreds
+    class Presenter
+      include ::Mainapp::Component
+      attr_struct :logger
+
+      def for_render(data)
+        %i[realname name smtp_authenticator smtp_protocol smtp_server smtp_port
+          user pass].inject({}) do |result, key|
+          result.merge key => send(key, data)
+        end
+      end
+
+      private
+
+      def method_missing(key, *args)
+        args.dig 0, key
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        super
+      end
+    end
+  end
+end

data/lib/mayaml/mutt_account_creds/template.mustache

@@ -0,0 +1,8 @@
+# vim: filetype=muttrc
+
+set realname="{{ realname }}"
+set from="{{ name }}"
+set smtp_url="{{ smtp_protocol }}://{{ user }}@{{ smtp_server }}:{{ smtp_port }}/" smtp_pass="{{ pass }}"
+set smtp_authenticators="{{ smtp_authenticator }}"
+set ssl_force_tls=yes
+set ssl_starttls=yes

data/lib/mayaml/mutt_account_creds/validator.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "mainapp/component"
+
+module Mayaml
+  module MuttAccountCreds
+    class Validator
+      include ::Mainapp::Component
+      attr_struct :logger
+
+      def validate(data)
+        %i[realname name smtp_protocol smtp_server smtp_port smtp_authenticator
+          user pass].each do |value|
+          raise ArgumentError.new "Missing #{value}" if missing?(data, value)
+        end
+      end
+
+      private
+
+      def missing?(data, value)
+        data[value].to_s.strip == ""
+      end
+    end
+  end
+end

data/lib/mayaml/mutt_account_creds.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "mayaml/base"
+require "mayaml/mutt_account_creds/generator"
+require "mayaml/mutt_account_creds/presenter"
+require "mayaml/mutt_account_creds/validator"
+
+module Mayaml
+  module MuttAccountCreds
+    STRUCTURE = {
+      mutt_account_creds_generator: proc do
+        Generator.new(
+          logger: logger.child(component: "mutt_account_creds_generator"),
+          presenter: mutt_account_creds_presenter,
+          validator: mutt_account_creds_validator
+        )
+      end,
+      mutt_account_creds_validator: proc do
+        Validator.new(
+          logger: logger.child(component: "mutt_account_creds_validator")
+        )
+      end,
+      mutt_account_creds_presenter: proc do
+        Presenter.new(
+          logger: logger.child(component: "mutt_account_creds_presenter")
+        )
+      end
+    }.freeze
+
+    ::Mayaml::Base.set STRUCTURE
+  end
+end

data/lib/mayaml/mutt_account_init/generator.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "mainapp/component"
+require "mustache"
+
+module Mayaml
+  module MuttAccountInit
+    class Generator
+      include ::Mainapp::Component
+      attr_struct :logger, :presenter, :default_accounts_dir, :validator
+
+      def render(index, prefix_path, data)
+        ext_data = data.merge(index: index, prefix_path: prefix_path)
+        validate_data(ext_data)
+        render_view(ext_data)
+      end
+
+      private
+
+      def validate_data(data)
+        validator.validate data
+      end
+
+      def render_view(data)
+        ::Mustache.template_path = __dir__
+        ::Mustache.render :template, presenter.for_render(data)
+      end
+    end
+  end
+end

data/lib/mayaml/mutt_account_init/presenter.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "mainapp/component"
+
+module Mayaml
+  module MuttAccountInit
+    class Presenter
+      include ::Mainapp::Component
+      attr_struct :logger
+
+      def for_render(data)
+        {
+          name: name(data),
+          accounts_path: accounts_path(data),
+          clean_name: clean_name(data)
+        }
+      end
+
+      private
+
+      def name(data)
+        data[:name]
+      end
+
+      def accounts_path(data)
+        File.join(
+          data[:prefix_path],
+          "accounts"
+        )
+      end
+
+      def clean_name(data)
+        "#{data[:index]}_#{data[:name].gsub(/\W/, "_")}"
+      end
+    end
+  end
+end

data/lib/mayaml/mutt_account_init/template.mustache

@@ -0,0 +1,3 @@
+send-hook '~f ^{{ name }}' 'source {{ accounts_path }}/{{ name }}'
+send2-hook '~f ^{{ name }}' 'source {{ accounts_path }}/{{ name }}'
+alias my_account_{{ clean_name }} {{ name }}

data/lib/mayaml/mutt_account_init/validator.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "mainapp/component"
+
+module Mayaml
+  module MuttAccountInit
+    class Validator
+      include ::Mainapp::Component
+      attr_struct :logger
+
+      def validate(data)
+        %i[name index].each do |value|
+          raise ArgumentError.new "Missing #{value}" if missing?(data, value)
+        end
+      end
+
+      private
+
+      def missing?(data, value)
+        data[value].to_s.strip == ""
+      end
+    end
+  end
+end

data/lib/mayaml/mutt_account_init.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "mayaml/base"
+require "mayaml/mutt_account_init/generator"
+require "mayaml/mutt_account_init/presenter"
+require "mayaml/mutt_account_init/validator"
+
+module Mayaml
+  module MuttAccountInit
+    STRUCTURE = {
+      mutt_account_init_generator: proc do
+        Generator.new(
+          logger: logger.child(component: "mutt_account_init_generator"),
+          presenter: mutt_account_init_presenter,
+          validator: mutt_account_init_validator
+        )
+      end,
+      mutt_account_init_validator: proc do
+        Validator.new(
+          logger: logger.child(component: "mutt_account_init_validator")
+        )
+      end,
+      mutt_account_init_presenter: proc do
+        Presenter.new(
+          logger: logger.child(component: "mutt_account_init_presenter")
+        )
+      end
+    }.freeze
+
+    ::Mayaml::Base.set STRUCTURE
+  end
+end

data/lib/mayaml/mutt_config_accounts.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "mayaml/base"
+require "mayaml/mutt_configs_accounts/handler"
+
+module Mayaml
+  module MuttConfigsAccounts
+    STRUCTURE = {
+      mutt_configs_accounts_handler: proc do
+        Handler.new(
+          mutt_account_creds_generator: mutt_account_creds_generator,
+          logger: logger.child(component: "mutt_configs_accounts_handler")
+        )
+      end
+    }.freeze
+
+    ::Mayaml::Base.set STRUCTURE
+  end
+end

data/lib/mayaml/mutt_config_default_account.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "mayaml/base"
+require "mayaml/mutt_configs_default_account/handler"
+
+module Mayaml
+  module MuttConfigsDefaultAccount
+    STRUCTURE = {
+      mutt_configs_default_account_handler: proc do
+        Handler.new(
+          logger: logger.child(component: "mutt_configs_default_account_handler")
+        )
+      end
+    }.freeze
+
+    ::Mayaml::Base.set STRUCTURE
+  end
+end

data/lib/mayaml/mutt_config_init.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "mayaml/base"
+require "mayaml/mutt_configs_init/handler"
+
+module Mayaml
+  module MuttConfigsInit
+    STRUCTURE = {
+      mutt_configs_init_handler: proc do
+        Handler.new(
+          mutt_account_init_generator: mutt_account_init_generator,
+          mutt_account_alternates_generator: mutt_account_alternates_generator,
+          logger: logger.child(component: "mutt_configs_init_handler")
+        )
+      end
+    }.freeze
+
+    ::Mayaml::Base.set STRUCTURE
+  end
+end

data/lib/mayaml/mutt_config_static.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "mayaml/base"
+require "mayaml/mutt_configs_static/handler"
+
+module Mayaml
+  module MuttConfigsStatic
+    STRUCTURE = {
+      mutt_configs_static_handler: proc do
+        Handler.new(
+          logger: logger.child(component: "mutt_configs_static_handler")
+        )
+      end
+    }.freeze
+
+    ::Mayaml::Base.set STRUCTURE
+  end
+end