Contents

#
# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
#
# This file is part of ronin.
#
# Ronin 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.
#
# Ronin 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 Ronin.  If not, see <https://www.gnu.org/licenses/>.
#

require 'ronin/model'

module Ronin
  module Model
    #
    # Adds a `version` property to a model.
    #
    module HasVersion
      #
      # Adds the `version` property and {ClassMethods} to the model.
      #
      # @param [Class] base
      #   The model.
      #
      # @api semipublic
      #
      def self.included(base)
        base.send :include, Model
        base.send :extend, ClassMethods

        base.module_eval do
          # The version of the model
          property :version, String, :default => '0.1', :index => true
        end
      end

      #
      # Class methods that are added when {HasVersion} is included into a
      # model.
      #
      module ClassMethods
        #
        # Finds all models with a specific version.
        #
        # @param [String] version
        #   The specific version to search for.
        #
        # @return [Array]
        #   The models with the specific version.
        #
        # @api public
        #
        def revision(version)
          all(:version => version.to_s)
        end

        #
        # Finds latest version of the model.
        #
        # @api public
        #
        def latest
          first(:order => [:version.desc])
        end
      end
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
ronin-1.5.1	lib/ronin/model/has_version.rb