railsmdb 1.0.0.alpha1

data/lib/railsmdb/ext/rails/generators/rails/app/app_generator.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'railsmdb/generators/setup/concerns/setuppable'
+
+module Rails
+  module Generators
+    # Monkeypatch the Rails AppGenerator class to make it emit a Mongoid-friendly
+    # application.
+    #
+    # @api private
+    class AppGenerator
+      include Railsmdb::Generators::Setup::Concerns::Setuppable
+
+      # change the --skip-active-record option to default to true. Users
+      # may pass --no-skip-active-record to enable it again, if they want
+      # to use both Mongoid and ActiveRecord.
+      class_option :skip_active_record, type: :boolean,
+                                        aliases: '-O',
+                                        default: true,
+                                        desc: 'Skip Active Record files'
+
+      prioritize :save_initial_path, :before, :create_root
+      prioritize :confirm_legal_shenanigans, :before, :create_root
+      prioritize :fetch_crypt_shared, :after, :create_root
+      prioritize :add_mongoid_gem_entries, :before, :run_bundle
+
+      public_task :save_initial_path
+      public_task :confirm_legal_shenanigans
+      public_task :fetch_crypt_shared
+      public_task :add_mongoid_gem_entries
+      public_task :mongoid_yml
+      public_task :add_mongodb_local_master_key_to_credentials
+      public_task :add_encryption_options_to_mongoid_yml
+      public_task :mongoid_initializer
+      public_task :railsmdb
+
+      # OVERRIDES
+      # The following methods override the existing methods on AppGenerator,
+      # to replace the default behavior with Mongoid-specific behavior.
+
+      # Overridden to ignore the "skip_active_record" guard. We always want the
+      # db folder, even when active record is being skipped.
+      def create_db_files
+        build(:db)
+      end
+    end
+  end
+end

data/lib/railsmdb/ext/rails/generators.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'railsmdb/ext/rails/command/behavior'
+
+module Rails
+  module Generators # :nodoc:
+    class << self
+      private
+
+      # Prepends the railsmdb generators lookup path to the existing rails
+      # lookup paths.
+      def railsmdb_lookup_paths
+        @railsmdb_lookup_paths ||= [ 'railsmdb/generators', *rails_lookup_paths ]
+      end
+
+      alias rails_lookup_paths lookup_paths
+      alias lookup_paths railsmdb_lookup_paths
+    end
+  end
+end

data/lib/railsmdb/extractor.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require 'minitar'
+require 'zlib'
+require 'zip'
+
+module Railsmdb
+  # A utility class for extracting a specific file from a given archive.
+  # Currently only supports .tgz, .tar.gz, and .zip archives.
+  class Extractor
+    # Returns the appropriate extractor class for the given archive path.
+    #
+    # @param [ String ] archive_path the path to the archive file
+    #
+    # @return [ ZipExtractor | TarGzipExtractor ] the extractor instance
+    #   corresponding to the given archive.
+    def self.for(archive_path)
+      case archive_path
+      when /\.(tgz|tar\.gz)$/ then TarGzipExtractor.new(archive_path)
+      when /\.zip$/ then ZipExtractor.new(archive_path)
+      else raise ArgumentError, "don't know how to extract #{archive_path}"
+      end
+    end
+
+    # The path to the archive.
+    attr_reader :archive_path
+
+    # Instantiates a new extractor with the given archive path.
+    #
+    # @param [ String ] archive_path the path to the archive.
+    def initialize(archive_path)
+      @archive_path = archive_path
+    end
+
+    # Extract the first file that matches the given pattern from the
+    # archive.
+    #
+    # @param [ Regexp ] pattern the pattern to use for finding the file
+    #
+    # @yield [ String, String ] report the name and contents of the first
+    #   matching file. It will never yield more than once.
+    #
+    # @return [ String | nil ] returns the name of the matching file, or
+    #   nil if no file matched.
+    #
+    # @raise [ NotImplementedError ] subclasses must override this method.
+    def extract(pattern)
+      raise NotImplementedError
+    end
+  end
+
+  # An extractor subclass for dealing with .zip files.
+  #
+  # @api private
+  class ZipExtractor < Extractor
+    # See Extractor#extract for documentation.
+    def extract(pattern)
+      Zip::File.open(archive_path).each do |entry|
+        if entry.name.match?(pattern)
+          yield entry.name, entry.get_input_stream.read.force_encoding('BINARY')
+          return entry.name
+        end
+      end
+
+      nil
+    end
+  end
+
+  # An extractor subclass for dealing with .tgz/.tar.gz files.
+  #
+  # @api private
+  class TarGzipExtractor < Extractor
+    # See Extractor#extract for documentation.
+    def extract(pattern)
+      reader.each_entry do |entry|
+        if entry.name.match?(pattern)
+          yield entry.name, entry.read.force_encoding('BINARY')
+          return entry.name
+        end
+      end
+
+      nil
+    end
+
+    # Returns a reader able to iterate over all the entries in the
+    # archive.
+    def reader
+      @reader ||= begin
+        gzip = Zlib::GzipReader.new(File.open(archive_path, 'rb'))
+        Minitar::Reader.new(gzip)
+      end
+    end
+  end
+end

data/lib/railsmdb/generators/mongoid/model/model_generator.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'rails/generators/named_base'
+
+module Mongoid
+  module Generators
+    # Generator implementation for creating a new model.
+    class ModelGenerator < Rails::Generators::NamedBase
+      desc 'Creates a Mongoid model'
+      argument :attributes, type: :array, default: [], banner: 'field:type field:type'
+
+      check_class_collision
+
+      def self.base_root
+        File.expand_path('../..', __dir__)
+      end
+
+      class_option :timestamps, type: :boolean, default: true
+      class_option :parent,     type: :string, desc: 'The parent class for the generated model'
+      class_option :collection, type: :string, desc: 'The collection for storing model\'s documents'
+
+      # Task for creating a new model file
+      def create_model_file
+        template 'model.rb.tt', File.join('app/models', class_path, "#{file_name}.rb")
+      end
+
+      hook_for :test_framework
+
+      private
+
+      def type_class_for(attribute)
+        case attribute.type
+        when :datetime then 'Time'
+        when :text then 'String'
+        when :boolean then 'Mongoid::Boolean'
+        else attribute.type.to_s.classify
+        end
+      end
+    end
+  end
+end

data/lib/railsmdb/generators/mongoid/model/templates/model.rb.tt

@@ -0,0 +1,19 @@
+<% module_namespacing do -%>
+class <%= class_name %><%= " < #{options[:parent].classify}" if options[:parent] %>
+<% unless options[:parent] -%>
+  include Mongoid::Document
+<% end -%>
+<% if options[:timestamps] -%>
+  include Mongoid::Timestamps
+<% end -%>
+<% if options[:collection] -%>
+  store_in collection: '<%= options[:collection] %>'
+<% end -%>
+<% attributes.reject(&:reference?).each do |attribute| -%>
+  field :<%= attribute.name %>, type: <%= type_class_for(attribute) %>
+<% end -%>
+<% attributes.select(&:reference?).each do |attribute| -%>
+  belongs_to :<%= attribute.name %>
+<% end -%>
+end
+<% end -%>