mayaml 1.0.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b20c8481f6bb916404aab132bf34cba05b8c4bb
-  data.tar.gz: 03289891d912af7a59b092308f71d1b5a4731b97
+  metadata.gz: 3a1938719052779c534faa1c12f6e740fca2178f
+  data.tar.gz: ef1d8942558d64c0f7c528427ba4e20bf3fff26e
 SHA512:
-  metadata.gz: d1c8673f2972f336871f1833adf1dc24ec88291a312b9d9ad0edf4378edfb21317bad073f94483beaf8d4fc395c696271688e023a7acb3dbfc0db8be2ff86ceb
-  data.tar.gz: 9b19993fd6331be4bab4e3b4f3295745b4fb4ab8ced5c1e37ade1eff5b0477fb7948a1f9e1fa9a65d22babf8d296df0750566aa6e72a49b819bf6b2cf17a3ef5
+  metadata.gz: 6f307cd6cf40c3f33a2bf47b6d0e12c1da97e16dd4ebb9a336cc2c4c5807f3bd7f34eb5c77e38b9d0bbf0b47e2b4d5a9cb79779788400b7c441c56fe18852f4a
+  data.tar.gz: 0aff4a69ec54e872f932ca5d83c0afde656ae7c9e46748769fd3df770b6358ae937612f6670c24abb27b2ed4f296eefeb25094d30613a67c417761ea6e844b85

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+=== 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)
 
 * fix bin script

data/README.md

@@ -1,6 +1,7 @@
 # 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...).
 
@@ -20,7 +21,7 @@ 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. 
+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:
 
 ```ruby
@@ -33,15 +34,32 @@ Mayaml.accounts_from_file(yaml_path).each { |account| ... }
 
 ```yaml
 - name: account_name
+  default: false
+  realname: Jon Foo
   type: imap
   server: test.mailserver.com
   port: 998
   user: user@mailserver.com
   pass: sercet_password
   mailboxes:
-    - INBOX 
+    - INBOX
 ```
 
+#### Required attributes
+
+* `name`
+* `type`
+* `server`
+* `port`
+* `user`
+* `pass`
+* `realname`
+
+#### Default attributes
+
+* `mailboxes` => `[]`
+* `default` => `false`
+
 ## Versioning
 
 See [semver.org][semver]

data/lib/mayaml.rb

@@ -32,6 +32,8 @@ module Mayaml
   def self.build_account(raw_account)
     MailAccount::Builder.build do |builder|
       builder.name raw_account.fetch("name")
+      builder.default raw_account.fetch("default", "false")
+      builder.realname raw_account.fetch("realname")
       builder.type raw_account.fetch("type")
       builder.server raw_account.fetch("server")
       builder.port raw_account.fetch("port")

data/lib/mayaml/mail_account.rb

@@ -19,20 +19,15 @@
 
 module Mayaml
   class MailAccount
-    attr_accessor :name, :type, :server, :port, :user, :pass, :mailboxes
+    attr_accessor :name, :default, :realname, :type, :server, :port, :user, :pass, :mailboxes
 
     def initialize
-      set_default_type
-      set_default_port
+      set_default_flag
       set_default_mailboxes
     end
 
-    def set_default_type
-      @type = :imap
-    end
-
-    def set_default_port
-      @port = 993
+    def set_default_flag
+      @default = false
     end
 
     def set_default_mailboxes
@@ -40,8 +35,9 @@ module Mayaml
     end
 
     def to_str
+      default_mark = @default ? "*" : ""
       <<-DESC
-        Account: #{@name} | user: #{@user}:#{@pass}
+        Account#{default_mark}: #{@name}<#{@realname}> | user: #{@user}:#{@pass}
           #{@type} - #{@server}:#{@port} [#{@mailboxes.join(",")}]
       DESC
     end

data/lib/mayaml/mail_account/builder.rb

@@ -22,6 +22,7 @@ require "mayaml/mail_account/required_attributes_validator"
 require "mayaml/mail_account/type_validator"
 require "mayaml/mail_account/port_validator"
 require "mayaml/mail_account/mailboxes_validator"
+require "mayaml/mail_account/default_flag_validator"
 
 module Mayaml
   class MailAccount
@@ -40,32 +41,31 @@ module Mayaml
         @account.name = name
       end
 
-      def type(str)
-        if str.nil? || str == ""
-          @account.set_default_type
+      def default(flag)
+        if flag.nil? || flag == ""
+          @account.set_default_flag
         else
-          validator = TypeValidator.new str
-          unless validator.valid?
-            raise WrongAccountType, validator.errors.join(" ")
-          end
-          @account.type = str.to_sym
+          valid_attribute DefaultFlagValidator, WrongDefaultFlag, flag
+          @account.default = (["true", true].include? flag)
         end
       end
 
+      def realname(realname)
+        @account.realname = realname
+      end
+
+      def type(str)
+        valid_attribute TypeValidator, WrongAccountType, str
+        @account.type = str.to_sym
+      end
+
       def server(str)
         @account.server = str
       end
 
       def port(nr)
-        if nr.nil? || nr == ""
-          @account.set_default_port
-        else
-          validator = PortValidator.new nr
-          unless validator.valid?
-            raise WrongAccountPort, validator.errors.join(" ")
-          end
-          @account.port = nr.to_i
-        end
+        valid_attribute PortValidator, WrongAccountPort, nr
+        @account.port = nr.to_i
       end
 
       def user(str)
@@ -80,10 +80,7 @@ module Mayaml
         if arr.nil? || arr.empty?
           @account.set_default_mailboxes
         else
-          validator = MailboxesValidator.new arr
-          unless validator.valid?
-            raise WrongAccountMailboxes, validator.errors.join(" ")
-          end
+          valid_attribute MailboxesValidator, WrongAccountMailboxes, arr
           @account.mailboxes = arr
         end
       end
@@ -98,11 +95,14 @@ module Mayaml
 
       def valid_account
         validator = RequiredAttributesValidator.new @account
-        unless validator.valid?
-          raise MissingAttributes, validator.errors.join(" ")
-        end
+        raise MissingAttributes, validator.errors.join(" ") unless validator.valid?
         @account.dup
       end
+
+      def valid_attribute(validator_class, error_class, attribute)
+        validator = validator_class.new attribute
+        raise error_class, validator.errors.join(" ") unless validator.valid?
+      end
     end
   end
 end

data/lib/mayaml/mail_account/default_flag_validator.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+# Copyright (C) 2016 Szymon Kopciewski
+#
+# This file is part of Mayaml.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module Mayaml
+  class MailAccount
+    class DefaultFlagValidator
+      attr_reader :errors
+
+      def initialize(flag)
+        @errors = []
+        unless [true, false, "true", "false"].include? flag
+          @errors << "Flag need to be 'true' or 'false'"
+        end
+      end
+
+      def valid?
+        @errors.empty?
+      end
+    end
+  end
+end

data/lib/mayaml/mail_account/error.rb

@@ -26,6 +26,9 @@ module Mayaml
     class MissingAttributes < Error
     end
 
+    class WrongDefaultFlag < Error
+    end
+
     class WrongAccountType < Error
     end
 

data/lib/mayaml/mail_account/required_attributes_validator.rb

@@ -25,6 +25,8 @@ module Mayaml
       def initialize(mail_account)
         @errors = []
         @errors << "Missing name attribute." if mail_account.name.nil?
+        @errors << "Missing realname attribute." if mail_account.realname.nil?
+        @errors << "Missing type attribute." if mail_account.type.nil?
         @errors << "Missing server attribute." if mail_account.server.nil?
         @errors << "Missing user attribute." if mail_account.user.nil?
         @errors << "Missing pass attribute." if mail_account.pass.nil?

data/lib/mayaml/version.rb

@@ -18,5 +18,5 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 module Mayaml
-  VERSION = "1.0.3".freeze
+  VERSION = "2.0.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mayaml
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 2.0.0
 platform: ruby
 authors:
 - Szymon Kopciewski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-24 00:00:00.000000000 Z
+date: 2016-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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: Mail Accounts from Yaml parser - the base classes
 email:
 - s.kopciewski@gmail.com
@@ -83,6 +97,7 @@ files:
 - lib/mayaml/error.rb
 - lib/mayaml/mail_account.rb
 - lib/mayaml/mail_account/builder.rb
+- lib/mayaml/mail_account/default_flag_validator.rb
 - lib/mayaml/mail_account/error.rb
 - lib/mayaml/mail_account/mailboxes_validator.rb
 - lib/mayaml/mail_account/port_validator.rb
@@ -110,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Mail Accounts from Yaml parser - the base classes