nvim_conf 0.1.0 → 0.1.1

data/lib/nvim_conf/managers/globals.rb

@@ -0,0 +1,46 @@
+require "nvim_conf/models/global"
+
+module NvimConf
+  module Managers
+    class Globals
+      attr_reader :globals
+
+      def initialize
+        @globals = []
+      end
+
+      def set(name, value = true)
+        store_global(
+          name,
+          value
+        )
+      end
+
+      class << self
+        def section_name
+          "Globals"
+        end
+      end
+
+      def store?
+        @globals.any?
+      end
+
+      def unset(name)
+        store_global(
+          name,
+          false
+        )
+      end
+
+      private
+
+      def store_global(name, value)
+        @globals << Models::Global.new(
+          name,
+          value
+        )
+      end
+    end
+  end
+end

data/lib/nvim_conf/{mappings/manager.rb → managers/mappings.rb}

@@ -1,9 +1,10 @@
-require "nvim_conf/mappings/mapping"
+require "nvim_conf/models/mapping"
+
 # TODO: Refactor error messages
 module NvimConf
-  module Mappings
-    class Manager < NvimConf::Manager
-      AVAILABLE_METHODS = %w[map map! nmap vmap imap cmap smap xmap omap lmap]
+  module Managers
+    class Mappings
+      AVAILABLE_METHODS = %w[map map! nmap vmap imap cmap smap xmap omap lmap tmap]
       attr_reader :mappings
 
       def initialize(namespace)
@@ -13,6 +14,12 @@ module NvimConf
         validate!
       end
 
+      class << self
+        def section_name
+          "Mappings"
+        end
+      end
+
       def validate!
         return if @namespace.nil? || @namespace.empty?
 
@@ -31,6 +38,14 @@ module NvimConf
         end
       end
 
+      AVAILABLE_METHODS.each do |operator|
+        define_method("r#{operator}") do |binding|
+          store_mapping(
+            operator, binding, nil, remove: true
+          )
+        end
+      end
+
       def new(binding, action)
         raise "No namespace was given for <mappings>" unless @namespace
         raise "No namespace was given for <mappings>" if @namespace.empty?
@@ -44,14 +59,14 @@ module NvimConf
 
       private
 
-      def store_mapping(operator, binding, action)
+      def store_mapping(operator, binding, action, **params)
         @mappings << build_mapping(
-          operator, binding, action
+          operator, binding, action, params
         )
       end
 
-      def build_mapping(operator, binding, action)
-        Mapping.new(operator, binding, action)
+      def build_mapping(operator, binding, action, params)
+        Models::Mapping.new(operator, binding, action, **params)
       end
     end
   end

data/lib/nvim_conf/{plugins/manager.rb → managers/plugins.rb}

@@ -1,16 +1,23 @@
-require "nvim_conf/plugins/plugin"
+require "nvim_conf/models/plugin"
 
 module NvimConf
-  module Plugins
-    class Manager < NvimConf::Manager
-      attr_reader :plugins, :name, :bootstraped
+  module Managers
+    class Plugins
+      attr_reader :plugins, :name, :title, :bootstraped
 
-      def initialize(name, bootstraped: false)
+      def initialize(name, title, bootstraped: false)
         @name = name
+        @title = title
         @bootstraped = bootstraped
         @plugins = []
       end
 
+      class << self
+        def section_name
+          "Plugins"
+        end
+      end
+
       def store?
         @plugins.any?
       end
@@ -31,7 +38,7 @@ module NvimConf
       end
 
       def build_plugin(name, params)
-        Plugin.new(
+        Models::Plugin.new(
           name,
           **params
         )

data/lib/nvim_conf/managers/requires.rb

@@ -0,0 +1,34 @@
+require "nvim_conf/models/require"
+
+# TODO: Refactor error messages
+module NvimConf
+  module Managers
+    class Requires
+      attr_reader :requires
+
+      def initialize
+        @requires = []
+      end
+
+      class << self
+        def section_name
+          "Requires"
+        end
+      end
+
+      def setup(file)
+        store_require(file)
+      end
+
+      private
+
+      def store?
+        @requires.any?
+      end
+
+      def store_require(file)
+        @requires << Models::Require.new(file)
+      end
+    end
+  end
+end

data/lib/nvim_conf/{settings/manager.rb → managers/settings.rb}

@@ -1,11 +1,12 @@
-require "nvim_conf/settings/setting"
+require "nvim_conf/models/setting"
 
 module NvimConf
-  module Settings
-    class Manager < NvimConf::Manager
-      attr_reader :settings
+  module Managers
+    class Settings
+      attr_reader :settings, :title
 
-      def initialize
+      def initialize(title)
+        @title = title
         @settings = []
       end
 
@@ -13,6 +14,12 @@ module NvimConf
         @settings.any?
       end
 
+      class << self
+        def section_name
+          "Settings"
+        end
+      end
+
       def set(key, value = nil, **params)
         store_setting(
           :set,
@@ -29,6 +36,15 @@ module NvimConf
         )
       end
 
+      def add(key, value, **params)
+        store_setting(
+          :add,
+          key: key,
+          value: value,
+          **params
+        )
+      end
+
       private
 
       def store_setting(operation, key:, value: nil, scope: :global)
@@ -36,7 +52,7 @@ module NvimConf
       end
 
       def build_setting(operation, key, value, scope)
-        Setting.new(operation, key, value, scope)
+        Models::Setting.new(operation, key, value, scope)
       end
     end
   end

data/lib/nvim_conf/models/command.rb

@@ -0,0 +1,15 @@
+require "dry-initializer"
+
+module NvimConf
+  module Models
+    class Command
+      extend Dry::Initializer
+
+      param :name
+      param :description
+      param :body
+
+      option :vim_exec, default: -> { false }
+    end
+  end
+end

data/lib/nvim_conf/{compiler_configurations → models}/compiler_configuration.rb

@@ -1,7 +1,7 @@
 require "dry-initializer"
 
 module NvimConf
-  module CompilerConfigurations
+  module Models
     class CompilerConfiguration
       extend Dry::Initializer
 

data/lib/nvim_conf/models/global.rb

@@ -0,0 +1,12 @@
+require "dry-initializer"
+
+module NvimConf
+  module Models
+    class Global
+      extend Dry::Initializer
+
+      param :name
+      param :value, default: -> { true }
+    end
+  end
+end

data/lib/nvim_conf/{mappings → models}/mapping.rb

@@ -1,13 +1,14 @@
 require "dry-initializer"
 
 module NvimConf
-  module Mappings
+  module Models
     class Mapping
       extend Dry::Initializer
 
       param :operator
       param :binding
       param :action
+      option :remove, default: -> { false }
     end
   end
 end

data/lib/nvim_conf/{plugins → models}/plugin.rb

@@ -1,7 +1,7 @@
 require "dry-initializer"
 
 module NvimConf
-  module Plugins
+  module Models
     class Plugin
       extend Dry::Initializer
 
@@ -14,6 +14,11 @@ module NvimConf
       option :file_types, optional: true
       option :cmd, optional: true
       option :run, optional: true
+      option :requires, optional: true
+
+      def self.optional_arguments
+        %i[as opt file_types branch run cmd requires]
+      end
     end
   end
 end

data/lib/nvim_conf/models/require.rb

@@ -0,0 +1,11 @@
+require "dry-initializer"
+
+module NvimConf
+  module Models
+    class Require
+      extend Dry::Initializer
+
+      param :file
+    end
+  end
+end

data/lib/nvim_conf/{settings → models}/setting.rb

@@ -1,7 +1,7 @@
 require "dry-initializer"
 
 module NvimConf
-  module Settings
+  module Models
     class Setting
       extend Dry::Initializer
 

data/lib/nvim_conf/utils/io_operator.rb

@@ -0,0 +1,21 @@
+require "forwardable"
+
+module NvimConf
+  module Utils
+    class IoOperator
+      extend Forwardable
+
+      def_delegators :@io, :write
+
+      def initialize(io)
+        @io = io
+      end
+
+      def write_separator
+        @io.write(
+          Utils::MarkdownFormatter.separator
+        )
+      end
+    end
+  end
+end

data/lib/nvim_conf/utils/markdown_formatter.rb

@@ -0,0 +1,35 @@
+module NvimConf
+  module Utils
+    class MarkdownFormatter
+      class << self
+        def collapisible(summary, content)
+          <<~FORMAT
+            <details>
+              <summary>
+                #{summary}
+              </summary>
+
+              #{content}
+            </details>
+          FORMAT
+        end
+
+        def separator(count: 2)
+          "\n" * count
+        end
+
+        def format_title(title, level: 0, indent: 0)
+          prefix = [
+            indent.positive? ? " " * indent : nil,
+            level != 0 ? "#" * level : nil
+          ].compact.join
+
+          [
+            prefix,
+            "#{title}\n\n"
+          ].compact.join(" ")
+        end
+      end
+    end
+  end
+end

data/lib/nvim_conf/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NvimConf
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/nvim_conf/writer.rb

@@ -27,7 +27,7 @@ module NvimConf
       File.open(documentation_file_path, "w+") do |file|
         NvimConf::Writers::Documentation::Orchestrator.new(
           @managers,
-          file,
+          Utils::IoOperator.new(file),
           @configuration
         ).aggregate_writes
       end

data/lib/nvim_conf/writers/code/commands.rb

@@ -0,0 +1,36 @@
+require "nvim_conf/generators/code/commands/lua"
+
+module NvimConf
+  module Writers
+    module Code
+      class CommandsWriter
+        COMMANDS_GENERATOR_MAPPING = {
+          lua: Generators::Commands::Code::Lua
+        }
+
+        def initialize(manager, io, format: :lua, commented: false)
+          @manager = manager
+          @io = io
+          @format = format
+        end
+
+        def write
+          @manager.commands.each do |command|
+            @io.write(
+              [
+                generator_class.new(command).generate,
+                "\n"
+              ].join
+            )
+          end
+        end
+
+        private
+
+        def generator_class
+          COMMANDS_GENERATOR_MAPPING[@format]
+        end
+      end
+    end
+  end
+end

data/lib/nvim_conf/writers/code/globals.rb

@@ -0,0 +1,36 @@
+require "nvim_conf/generators/code/globals/lua"
+
+module NvimConf
+  module Writers
+    module Code
+      class GlobalsWriter
+        GLOBAL_GENERATOR_MAPPING = {
+          lua: Generators::Globals::Code::Lua
+        }
+
+        def initialize(manager, io, format: :lua, commented: false)
+          @manager = manager
+          @io = io
+          @format = format
+        end
+
+        def write
+          @manager.globals.each do |global|
+            @io.write(
+              [
+                generator_class.new(global).generate,
+                "\n"
+              ].join
+            )
+          end
+        end
+
+        private
+
+        def generator_class
+          GLOBAL_GENERATOR_MAPPING[@format]
+        end
+      end
+    end
+  end
+end

data/lib/nvim_conf/writers/code/mappings.rb

@@ -14,7 +14,6 @@ module NvimConf
           @manager = manager
           @io = io
           @format = format
-          @commented = commented
         end
 
         def write

data/lib/nvim_conf/writers/code/orchestrator.rb

@@ -1,17 +1,23 @@
 require "nvim_conf/writers/code/settings"
+require "nvim_conf/writers/code/requires"
+require "nvim_conf/writers/code/globals"
+require "nvim_conf/writers/code/commands"
 require "nvim_conf/writers/code/mappings"
-require "nvim_conf/writers/code/plugins"
+require "nvim_conf/writers/code/plugins/handler"
 
 module NvimConf
   module Writers
     module Code
       class Orchestrator
-        NON_WRITABLE_MANAGER = NvimConf::CompilerConfigurations::Manager
+        NON_WRITABLE_MANAGER = NvimConf::Managers::CompilerConfigurations
 
         WRITER_CONFIGURATION = {
-          NvimConf::Settings::Manager => SettingsWriter,
-          NvimConf::Mappings::Manager => MappingsWriter,
-          NvimConf::Plugins::Manager => PluginsWriter
+          NvimConf::Managers::Settings => SettingsWriter,
+          NvimConf::Managers::Mappings => MappingsWriter,
+          NvimConf::Managers::Plugins => Code::Plugins::Handler,
+          NvimConf::Managers::Globals => GlobalsWriter,
+          NvimConf::Managers::Requires => RequiresWriter,
+          NvimConf::Managers::Commands => CommandsWriter
         }
 
         def initialize(managers, io, configuration = nil)
@@ -22,17 +28,36 @@ module NvimConf
 
         def aggregate_writes
           @managers.select { |manager| manager.class != NON_WRITABLE_MANAGER }.each_with_index do |manager, index|
-            if index.positive?
+            @io.write(
+              NvimConf::Commenter.comment_block(
+                @configuration,
+                manager_section_name(manager),
+                spacer: index.positive?
+              )
+            )
+
+            if index.positive? || @configuration[:commented]
               @io.write(
                 separator
               )
             end
+
             aggregate_writes_for_manager(manager)
           end
         end
 
         private
 
+        def manager_section_name(manager)
+          return manager.class.section_name unless manager.respond_to?(:title)
+          return manager.class.section_name if manager.title.nil?
+
+          [
+            manager.class.section_name,
+            manager.title
+          ].join(" - ")
+        end
+
         def separator
           "\n\n"
         end

data/lib/nvim_conf/writers/code/plugins/configuration.rb

@@ -0,0 +1,25 @@
+require_relative "./packer"
+require_relative "./paq"
+
+module NvimConf
+  module Writers
+    module Code
+      module Plugins
+        class Configuration
+          PLUGIN_CONFIGURATION = {
+            packer: {
+              generator: NvimConf::Generators::Plugins::Code::Packer,
+              writer: NvimConf::Writers::Code::Plugins::Packer,
+              indent: 2
+            },
+            paq: {
+              generator: NvimConf::Generators::Plugins::Code::Paq,
+              writer: NvimConf::Writers::Code::Plugins::Paq,
+              indent: 2
+            }
+          }
+        end
+      end
+    end
+  end
+end

data/lib/nvim_conf/writers/code/plugins/handler.rb

@@ -0,0 +1,25 @@
+require_relative "./configuration"
+
+module NvimConf
+  module Writers
+    module Code
+      module Plugins
+        class Handler
+          def initialize(manager, io, _params)
+            @manager = manager
+            @io = io
+            @configuration = Configuration::PLUGIN_CONFIGURATION[manager.name.to_sym]
+          end
+
+          def write
+            @configuration[:writer].new(
+              @manager,
+              @io,
+              @configuration
+            ).write
+          end
+        end
+      end
+    end
+  end
+end